Transport-for-the-North / caf.toolkit

Toolkit of transport planning and appraisal functionalities.

https://caftoolkit.readthedocs.io/en/stable/

Other

0 stars 2 forks source link

Added Entry Point for Running with Pipx and Updated Documentation #136

Closed MattBuckley-TfN closed 1 month ago

MattBuckley-TfN commented 3 months ago

Describe Changes

[x] Added entry point to for using caf.toolkit with pipx.
[x] Updated docs to be inline with other CAF packages
[x] Update docs showing how to install and use with pipx and command-prompt

Task Checklist

[ ] ~~Have unittests been added (testing individual functions and their edge cases)~~ - NA
[ ] ~~Have integration tests been added (if applicable, to test modules of functionality)~~ - NA
[x] Have new dependencies been added? - yes to docs requirements
- [x] Have they been added to either requirements.txt or requirements_dev.txt.
- [x] Have they been added to pyproject.toml

MattBuckley-TfN commented 1 month ago

@BenTaylor-TfN - ready for you

MattBuckley-TfN commented 1 month ago

Looks good!

Please could you add an issue to update the -h text for the CLI and we can wrap this up!

147