Skip to main content

Shared development tools for Python projects - character validation, circular import detection, and more

Project description

apdev (Python)

Shared development tools for Python projects.

Installation

pip install apdev

For development:

pip install apdev[dev]

Tools

check-chars

Validate that files contain only allowed characters (ASCII, common emoji, and technical symbols like arrows and box-drawing characters).

# Check specific files
apdev check-chars src/mypackage/*.py

# Use with pre-commit (see below)

check-imports

Detect circular imports in a Python package.

# Specify package explicitly
apdev check-imports --package mypackage --src-dir src

# Or configure in pyproject.toml (see below)
apdev check-imports

release

Interactive release automation for publishing Python packages to PyPI and GitHub. Auto-detects project name from pyproject.toml and GitHub repo from git remote.

# Run with auto-detected version from pyproject.toml
apdev release

# Or specify version explicitly
apdev release 0.2.0

The command provides an interactive menu with steps:

  1. Version verification (checks pyproject.toml and __init__.py match)
  2. Status check (tag, build files, PyPI)
  3. Clean build files
  4. Build package (python -m build)
  5. Check package (twine check)
  6. Create git tag and push
  7. Create GitHub release (via gh CLI or API)
  8. Upload to PyPI (twine upload)

Override auto-detection with environment variables:

PROJECT_NAME=mypackage GITHUB_REPO=owner/repo apdev release

Configuration

Add to your project's pyproject.toml:

[tool.apdev]
base_package = "mypackage"
src_dir = "src"

Pre-commit Integration

repos:
  - repo: https://github.com/aipartnerup/apdev
    rev: python/v0.1.0
    hooks:
      - id: check-chars
      - id: check-imports

Or use as a local hook with the pip-installed package:

repos:
  - repo: local
    hooks:
      - id: check-chars
        name: apdev check-chars
        entry: apdev check-chars
        language: system
        types_or: [text, python]

      - id: check-imports
        name: apdev check-imports
        entry: apdev check-imports
        language: system
        pass_filenames: false
        always_run: true

License

Apache-2.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

apdev-0.1.6.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

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

apdev-0.1.6-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file apdev-0.1.6.tar.gz.

File metadata

  • Download URL: apdev-0.1.6.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for apdev-0.1.6.tar.gz
Algorithm Hash digest
SHA256 a7d0edd9852366de69e09806829630d9f48ac079b7ee33c8d66c92180ae3b00f
MD5 32c788d259617fba20503370fb244bb4
BLAKE2b-256 d8c38dbba1012c4a52c06ece3889feb1ab0ef5855703b7b164fb4a6fd8220f13

See more details on using hashes here.

File details

Details for the file apdev-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: apdev-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for apdev-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4a767a96913b37c6ed4ebabc206a4821938429275308f9add71184c7baf186a2
MD5 4b940613ee769ed6a5cb86d60480e1b8
BLAKE2b-256 e97d8982f3dfe2d4a7a69f81cb2fb3344da0f7741967428763f9a9ca6d4d7310

See more details on using hashes here.

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