ian/pota-local-progress
1
0
Fork 0
Code Issues Pull requests Activity

Package script #2

Merged
crvallance merged 13 commits from make_installable into main 2024-11-30 08:07:37 +00:00
Conversation 1 Commits 13 Files changed 7 +323 -89
crvallance commented 2024-11-30 00:23:24 +00:00 (Migrated from github.com)
Copy link

This PR wraps the original script in a package, making it pip installable. High level of the changes:

  • Expanded .gitignore to leverage the GitHub Python example.
  • Updated README to show how to use script entry point and pipx example.
  • Added pyproject.toml file.
  • Setup init file which also tracks version.
  • Setup main file for potential future use.
    • This isn't expressly called out right now but python3 -m pota_local_progress will work when installed by pip.
  • Renamed the main execution file to "cli". The package name and project script provide relative compatibility to how the script operated before.
This PR wraps the original script in a package, making it pip installable. High level of the changes: - Expanded .gitignore to leverage the GitHub Python example. - Updated README to show how to use script entry point and pipx example. - Added pyproject.toml file. - Setup init file which also tracks version. - Setup main file for potential future use. - This isn't expressly called out right now but `python3 -m pota_local_progress` will work when installed by pip. - Renamed the main execution file to "cli". The package name and project script provide relative compatibility to how the script operated before.
ianrenton commented 2024-11-30 08:07:33 +00:00 (Migrated from github.com)
Copy link

Thanks, I had never really looked into packaging python scripts before. Followed the new instructions in the README and it works fine, though I had to run pipx ensurepath when prompted. PR accepted, thanks for contributing!

Thanks, I had never really looked into packaging python scripts before. Followed the new instructions in the README and it works fine, though I had to run `pipx ensurepath` when prompted. PR accepted, thanks for contributing!
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ian/pota-local-progress!2
No description provided.