handbook.vantage.sh icon indicating copy to clipboard operation
handbook.vantage.sh copied to clipboard

Add poetry dependency management

Open tcoyze opened this issue 2 years ago • 2 comments

First contrib! Found making mkdocs dependency a little easier to track and manage with poetry.

LMK thoughts on the pyproject.toml configuration file as well if you want the contact and/or description updated.

tcoyze avatar Mar 09 '23 18:03 tcoyze

@tcoyze thank you! Could you share a little more about the use case for poetry here? Afaik there are fairly limited dependencies for this particular project.

EverettBerry avatar Mar 14 '23 21:03 EverettBerry

@tcoyze thank you! Could you share a little more about the use case for poetry here? Afaik there are fairly limited dependencies for this particular project.

No problem! It is generally a good idea to track dependencies and their versions for a particular project. Since this project utilizes mkdocs and the material theme, those dependencies are needed to build the project locally for development. A dependency file (requirements.txt, pyproject.toml, Pipfile, etc) makes it easier to install and manage those dependencies. Poetry is one such tool in the python ecosystem, and it seems to be the most popular of the dependency managers. A legacy form would be akin to the requirements.txt file using pip directly.

An alternative to the above could be updating the documentation to include the additional mkdocs-material dependency is also required.

tcoyze avatar Mar 14 '23 23:03 tcoyze