Welcome to PyTestArch
PyTestArch is an open source library that allows users to define architectural rules and test their code against them. It is generally inspired by ArchUnit.
Installation Guide
PyTestArch is available via PyPI and can be installed e.g. via pip: pip install pytestarch. To also install the
optional dependency matplotlib, which is required to draw the created dependency graphs, install pytestarch[visualization]
Usage Guide
Three steps are required to test an architectural rule:
- Create an evaluable representation of the source code you want to test
from pytestarch import get_evaluable_architecture
evaluable = get_evaluable_architecture("/home/dummy/project", "/home/dummy/project/src")
This will scan all python files under /home/dummy/project/src for imports and build an internal representation that can later be queried. The first parameter /home/dummy/project helps PyTestArch to differentiate between internal and external dependencies. This evaluable can be used for multiple architectural rule checks; if you are using pytest, you could use a fixture for this evaluable object.
- Define an architectural rule
from pytestarch import Rule
rule = (
Rule()
.modules_that()
.are_named("project.src.moduleB")
.should_not()
.be_imported_by_modules_that()
.are_sub_modules_of("project.src.moduleA")
)
This rule represents the architectural requirements that a module named "project.src.moduleB" should not be imported by any module that is a submodule of "project.src.moduleA", excluding "project.src.moduleA" itself.
- Evaluate your code against this rule
rule.assert_applies(evaluable)
That's it!
1 maintainer
Metadata
1 maintainer
Release files for PyTestArch 4.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pytestarch-4.0.1.tar.gz | 42.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pytestarch-4.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 104.7 kB
Release files / pytestarch-4.0.1.tar.gz
| Download URL | pytestarch-4.0.1.tar.gz |
|---|---|
| Size | 42.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2f288eb8a8a818d3d89a45180d1756c4db2885a7a1281c4ac019665ed97db6b9
|
|
BLAKE2b-256 checksum How to use checksums |
42a288b37e1133457c224155c29ae3619915977063e44fbf0d1780012aeb6a3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 8, 2025.
Transparency logRelease files / pytestarch-4.0.1-py3-none-any.whl
| Download URL | pytestarch-4.0.1-py3-none-any.whl |
|---|---|
| Size | 62.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4dd5adc363b3e1fde72d4b34564f03e62f715cc5e38f1c3a347b0f1cc92168fe
|
|
BLAKE2b-256 checksum How to use checksums |
ac6e8b6079324672f03fd4b914345ecd2df95a04caf658faf4d7f7e7fa97d543
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 8, 2025.
Transparency log
