Skip to main content

Simple linter to enforce various aspects of source code structure.

Project description

structlint

Configurable development CLI that checks various aspects of architecture: method order, documentation, tests, and internal module dependency.

Roadmap

  1. configuration tests (thorough)
  2. remaining tests
    • checks_test.py
    • cli_test.py
    • collection_test.py
    • configuration_test.py
    • logic_test.py
    • reporting_test.py
    • utils_test.py
  3. configuration docs
  4. add explicit mapping tables
  5. update configuration tests
  6. update configuration docs
  7. code once-over
  8. docs once-over
  9. tests once-over
  10. project infra overhaul
  11. docs CI -> publish docs
  12. publish package on pypi
  13. add CLI package output to flake.nix
  14. add to all projects and collect live-use feedback
  15. version 0.3.0
  16. share on reddit, get feedback
  17. release 0.4.0
  18. performance optimization
  19. release 0.5.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

structlint-0.1.0.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

structlint-0.1.0-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file structlint-0.1.0.tar.gz.

File metadata

  • Download URL: structlint-0.1.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for structlint-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cb6d28c91964bdf8f9c89a4fc79a0d6b76e884393e7ad20a73b3a54a1dde7755
MD5 055a0c9e2d74ad6a2d4276ebf9b9bff8
BLAKE2b-256 f50c2d275abbf96659b9be1f63ebe67c8378a56d74c68b3fcbd3fc0931fbcade

See more details on using hashes here.

Provenance

The following attestation bundles were made for structlint-0.1.0.tar.gz:

Publisher: python-publish.yml on yelircaasi/structlint

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file structlint-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: structlint-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for structlint-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5a772b368dcc513664ce90a0f8afd97c6f1ad8d47f378b8bb6ba9ecce6d827af
MD5 1d22e7c3b8396cb55053d4ae2c7b8b39
BLAKE2b-256 c0eb64ab6f582c2b24ab2481179a147aac32ece272f50f7e7abb7d39134d6d6a

See more details on using hashes here.

Provenance

The following attestation bundles were made for structlint-0.1.0-py3-none-any.whl:

Publisher: python-publish.yml on yelircaasi/structlint

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page