Skip to main content

The Non-Destructive Configuration Steward for Python Projects.

Project description

ApexCodexPy

The Non-Destructive Configuration Steward for Python Projects.

ApexCodexPy is a CLI tool designed to enforce consistent linting and typing standards across multiple projects. Unlike standard runners, ApexCodexPy synchronizes your pyproject.toml with a "Gold Standard" configuration without destroying existing project-specific settings or comments.

🚀 Purpose

Modern Python development often suffers from "Config Drift"—where different projects slowly diverge in their ruff or mypy settings. ApexCodexPy solves this by:

Enforcing Standards

Overwriting critical linting rules with a centralized set of best practices.

Preserving Context

Using tomlkit to ensure that your handwritten comments and formatting remain intact.

Dry-Run Capability

Allowing developers to see exactly what would change before any modifications are written to disk.

📦 Installation & Integration

From PyPI

Since ApexCodexPy is available on PyPI, you can add it directly to your project using Poetry:

poetry add apexcodexpy --group dev

🛠 Usage

1. Synchronize Configuration

Align your pyproject.toml with the ApexCodexPy standards.

# Preview changes (Dry Run)
codex update --dry-run

# Apply changes
codex update

2. Run Linting & Formatting checks

Run the enforced toolchain (Ruff and Mypy) on your project.

# Standard run (verbose)
codex lint

# No output (suppress stdout/stderr)
codex lint --silent

3. Auto formating and fixing

Run the enforced toolchain (Ruff and Mypy) on your project.

# Standard run (verbose)
codex fix

# No output (suppress stdout/stderr)
codex fix --silent

🧩 Standards Enforced

ApexCodexPy currently enforces a strict ruff.lint.select list including:

Name Code
pyflakes F
pycodestyle (Errors) E
pycodestyle (Warnings) W
isort I
pep8-naming N
pyupgrade UP
flake8-bugbear B
flake8-builtins A
flake8-comprehensions C4
flake8-print T20
flake8-pytest-style PT
flake8-raise RSE
flake8-return RET
flake8-simplify SIM
flake8-unused-arguments ARG

It also enforces mypy.strict = true.

👨‍💻 For Developers: How it Works

Non-Destructive Merge

The core logic resides in a functional deep_merge. It takes the project's current TOML and the ApexCodexPy standards, returns a new configuration, and preserves all tomlkit item metadata (inline comments).

Architecture: Strategy Pattern

  • Task Protocol: implementations run various tools and report their results.
  • Device Protocol: used by reporter to output results.
  • Reporter: standard output format.
  • PyCodex: Class that ties everything together.

To add a new tool:

  • Create a new Task implementation.
  • Add the tool's standard config to get_standards().
  • Register the task in PyCodex.
  • Add CLI command using the above-mentioned PyCodex method.

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

apexcodexpy-0.2.1.tar.gz (20.7 kB view details)

Uploaded Source

Built Distribution

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

apexcodexpy-0.2.1-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file apexcodexpy-0.2.1.tar.gz.

File metadata

  • Download URL: apexcodexpy-0.2.1.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Linux/6.17.0-1015-azure

File hashes

Hashes for apexcodexpy-0.2.1.tar.gz
Algorithm Hash digest
SHA256 dc3a5412adb7485928e8ef96b384a8c0c9d0d5c843a0919dcc2e86c77fa3cca9
MD5 58432876c2a6e93b791c2754cafa5cb2
BLAKE2b-256 bb80b5c0c910e90099274d0730979dcf140bc6e00282c01ba915fe519fedec9a

See more details on using hashes here.

File details

Details for the file apexcodexpy-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: apexcodexpy-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 22.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Linux/6.17.0-1015-azure

File hashes

Hashes for apexcodexpy-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04f8db9d189d3c3b36fc24b025be42faf64a7c754be2db6338a258446c5945a0
MD5 24436a657ee39d611ba0151980154f63
BLAKE2b-256 8bd22516d3657de2e562300b1740913608941f0f24b9e6c42ccdaa47eab0ab36

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