Depcheck is a command line code-quality tool which supports adopting a layered architecture
by making it possible to specify dependency constraints between packages of your own Python application.
The tool aims to achieve the same goals as [Deptrac][deptrac] in PHP and [JDepend][jdepend] in Java
## Install
- Via [`poetry`][poetry] (recommended): Install with `poetry add depcheck`
- Via `pip`: Install from [Pypi][pypi-link] via `pip install depcheck`
## Usage
To run via CLI you run:
```shell
depcheck <root_dir> -f <config_file>
# Or, with poetry
poetry run depcheck <root_dir> -f <config_file>
```
The `example` directory demonstrates how the tool works.
```shell
cd example
poetry run depcheck example -f .depcheck.ok.yml # This should be correct
poetry run depcheck example -f .depcheck.errors.yml # This should give errors
```
To understand how to configure the tool, look inside the YML files. The `-f` argument is optional.
Implicitly, the tool will look for `.depcheck.yml`.
**NOTE:** Package directories should contain `__init__.py` to be recognized as a package!
## Contributing
All contributions are welcomed! See our [CONTRIBUTING.md][contribution] document.
<!-- Links -->
[hexagonal-architecture]: https://en.wikipedia.org/wiki/Hexagonal_architecture_(software)
[upgrade-python-version]: ./docs/upgrade-python-version.md
[update-project-dependencies]: ./docs/upgrade-python-version.md
[pypi-link]: https://pypi.org/project/depcheck/
[contribution]: ./CONTRIBUTING.md
[deptrac]: https://github.com/qossmic/deptrac
[jdepend]: https://github.com/clarkware/jdepend
[poetry]: https://python-poetry.org/
Raw data
{
"_id": null,
"home_page": "https://github.com/flix-tech/depcheck",
"name": "depcheck",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "dependencies,hexagonal,architecture,jdepend,deptrac",
"author": "FlixMobility Tech",
"author_email": "open-source@flixbus.com",
"download_url": "https://files.pythonhosted.org/packages/78/65/f69b2de2fb1a90630766e2aa0305e58794ea751fbae145b3457bbe2d895d/depcheck-0.3.2.tar.gz",
"platform": null,
"description": "\n\nDepcheck is a command line code-quality tool which supports adopting a layered architecture\nby making it possible to specify dependency constraints between packages of your own Python application.\nThe tool aims to achieve the same goals as [Deptrac][deptrac] in PHP and [JDepend][jdepend] in Java\n\n## Install\n- Via [`poetry`][poetry] (recommended): Install with `poetry add depcheck`\n- Via `pip`: Install from [Pypi][pypi-link] via `pip install depcheck`\n\n## Usage\nTo run via CLI you run:\n```shell\ndepcheck <root_dir> -f <config_file>\n\n# Or, with poetry\npoetry run depcheck <root_dir> -f <config_file>\n```\n\nThe `example` directory demonstrates how the tool works.\n\n```shell\ncd example\n\npoetry run depcheck example -f .depcheck.ok.yml # This should be correct\npoetry run depcheck example -f .depcheck.errors.yml # This should give errors\n```\n\nTo understand how to configure the tool, look inside the YML files. The `-f` argument is optional.\nImplicitly, the tool will look for `.depcheck.yml`.\n\n**NOTE:** Package directories should contain `__init__.py` to be recognized as a package!\n\n\n## Contributing\nAll contributions are welcomed! See our [CONTRIBUTING.md][contribution] document.\n\n\n<!-- Links -->\n[hexagonal-architecture]: https://en.wikipedia.org/wiki/Hexagonal_architecture_(software)\n[upgrade-python-version]: ./docs/upgrade-python-version.md\n[update-project-dependencies]: ./docs/upgrade-python-version.md\n[pypi-link]: https://pypi.org/project/depcheck/\n[contribution]: ./CONTRIBUTING.md\n[deptrac]: https://github.com/qossmic/deptrac\n[jdepend]: https://github.com/clarkware/jdepend\n[poetry]: https://python-poetry.org/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python code quality package that helps in defining and restricting how components of your code may interact",
"version": "0.3.2",
"project_urls": {
"Documentation": "https://github.com/flix-tech/depcheck",
"Homepage": "https://github.com/flix-tech/depcheck",
"Repository": "https://github.com/flix-tech/depcheck"
},
"split_keywords": [
"dependencies",
"hexagonal",
"architecture",
"jdepend",
"deptrac"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d8a5719d375d9ea160ca795ade838629bec1fd0ca55f701f5edd9c5f609dc08",
"md5": "a3aa72794733c6f2424758069790f87c",
"sha256": "f30fe379ae3a91bd2cc2a1b4b1bacbbc2c58aad2c38dfd6a474a44a1db3bf224"
},
"downloads": -1,
"filename": "depcheck-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a3aa72794733c6f2424758069790f87c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 7597,
"upload_time": "2023-06-06T09:13:29",
"upload_time_iso_8601": "2023-06-06T09:13:29.000210Z",
"url": "https://files.pythonhosted.org/packages/2d/8a/5719d375d9ea160ca795ade838629bec1fd0ca55f701f5edd9c5f609dc08/depcheck-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7865f69b2de2fb1a90630766e2aa0305e58794ea751fbae145b3457bbe2d895d",
"md5": "790a998dd6c0c662dec1c2fa915150ba",
"sha256": "93987b5ff93f026edd4c43544ecf1256abce78230f308b5fd6bb6e9dcb89c5ab"
},
"downloads": -1,
"filename": "depcheck-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "790a998dd6c0c662dec1c2fa915150ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 5791,
"upload_time": "2023-06-06T09:13:30",
"upload_time_iso_8601": "2023-06-06T09:13:30.771033Z",
"url": "https://files.pythonhosted.org/packages/78/65/f69b2de2fb1a90630766e2aa0305e58794ea751fbae145b3457bbe2d895d/depcheck-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-06 09:13:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flix-tech",
"github_project": "depcheck",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "depcheck"
}
JSON
