Depcheck is a tool to check package dependencies between predefined layers to make sure that the application always complies with the Hexagonal Architecture principle of creating loosely coupled application components.
Project description
Depcheck is a tool to check package-dependencies between predefined layers.
In the configuration file(.depcheck.yml
) located in the project root,
which packages belong to which layers and allowed dependencies between
layers are configurable. In this way, you can make sure that the application
always complies with the Hexagonal Architecture
principle of creating loosely coupled application components.
Install
Install from Pypi via pip install depcheck
Usage
Let's say you have a project with the directory structure below:
project_directory
root_package
package-1
package-2
main.py
README.md
.gitignore
.depcheck.yml
- Navigate to the
project_directory
then rundepcheck
for your project:depcheck root_package
- As you can see in the directory structure above, we have
.depcheck.yml
configuration file in the project directory. If you would like to change the path of the configuration file, use-f
or--file
argument:depcheck root_package -f config/customized_depcheck.yml
Contributing
All contributions are welcomed! Start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question. If you don't see your idea listed, open a pull request.
Maintenance Work
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.