seddonym / import-linter

Import Linter allows you to define and enforce rules for the internal and external imports within your Python project.
https://import-linter.readthedocs.io/
BSD 2-Clause "Simplified" License
692 stars 49 forks source link

Improve setup and docs #239

Open fraser-langton opened 1 month ago

fraser-langton commented 1 month ago

Just adding a bit more docs on getting setup, just feedback from a first timer setting up the repo :)

I went with a basic requirements-dev.txt to hold the requirements in one spot (updated tox to reference them as well) - but maybe consider poetry?

I also tweaked the black, isort, mypy configs so they all run using <command> . (and only runs on project files) - for me I think that's kind of convention for those tools.

I also ran isort, and added to tox.ini