Skip to content

Create a command line executable#73

Merged
Thomas-Rowlands merged 9 commits intomainfrom
package-ablility
Nov 1, 2024
Merged

Create a command line executable#73
Thomas-Rowlands merged 9 commits intomainfrom
package-ablility

Conversation

@AdrianDAlessandro
Copy link
Copy Markdown
Collaborator

@AdrianDAlessandro AdrianDAlessandro commented Nov 1, 2024

Description

This PR does a few things towards achieving #32, it:

  • Renames the package from src to autocorpus (package naming convention recommends all lowercase and no underscores)
  • Moves the run_app.py script into the autocorpus package and makes it runnable as a main package script (ie python -m autocorpus)
  • It makes a command-line executable script auto-corpus than can be run directly without python -m
  • It updates the "Getting Started" section of the readme to reflect the above and installation with Poetry

Fixes #72

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass (eg. pytest)
  • The documentation builds and looks OK (eg. mkdocs)
  • Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

Copy link
Copy Markdown
Collaborator

@Thomas-Rowlands Thomas-Rowlands left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran fine & thanks for this rename, its been a personal pet peeve of mine for some years now!

@Thomas-Rowlands Thomas-Rowlands merged commit e379ddc into main Nov 1, 2024
@AdrianDAlessandro AdrianDAlessandro deleted the package-ablility branch November 1, 2024 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move run_app.py into the main module

2 participants