Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

tcoyze
Copy link

@tcoyze tcoyze commented Mar 9, 2023

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 tcoyze changed the title Feature/add poetry dependency management Add poetry dependency management Mar 9, 2023
@EverettBerry
Copy link
Contributor

@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.

@tcoyze
Copy link
Author

tcoyze commented Mar 14, 2023

@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.

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.

2 participants