Skip to content

README.md

Latest commit

 

History

History
98 lines (69 loc) · 3.87 KB

README.md

File metadata and controls

98 lines (69 loc) · 3.87 KB

cdd-python-all

License CI Test Coverage Doc Coverage

OpenAPI ↔ Python. This is one compiler in a suite, all focussed on the same task: Compiler Driven Development (CDD).

Each compiler is written in its target language, is whitespace and comment sensitive, and has both an SDK and CLI.

The core philosophy of Compiler Driven Development (CDD) is synchronization without compromise. Where traditional generators silo your API boundaries into read-only files, this compiler natively merges changes into your codebase via a robust, [whitespace and comment aware] Abstract Syntax Tree (AST) driven parser & emitter. It bridges the gap between design and implementation, allowing you to seamlessly generate SDKs from a spec or extract a spec from existing code. By keeping your APIs, SDKs, and tests in continuous, automated alignment, it drastically improves both delivery speed and software reliability.

The CLI—at a minimum—has:

  • cdd-python-all --help
  • cdd-python-all --version
  • cdd-python-all from_openapi to_sdk_cli -i spec.json
  • cdd-python-all from_openapi to_sdk -i spec.json
  • cdd-python-all from_openapi to_server -i spec.json
  • cdd-python-all to_openapi -f path/to/code
  • cdd-python-all to_docs_json --no-imports --no-wrapping -i spec.json
  • cdd-python-all serve_json_rpc --port 8080 --listen 0.0.0.0

SDK Example

from cdd import generate_sdk, Config

if __name__ == '__main__':
    config = Config(input_path='spec.json', output_dir='src/models')
    generate_sdk(config)
    print("SDK generation complete.")

Installation

python3 -m pip install -e .

Development

You can use standard tooling commands or the included cross-platform Makefiles to fetch dependencies, build, and test:

python3 -m pip install -e .
python3 -m pytest
# or
make deps
make build
make test
# or on Windows
.\make.bat deps
.\make.bat build
.\make.bat test

See PUBLISH.md for packaging and releasing.

Features

The cdd-python-all compiler leverages a unified architecture to support various facets of API and code lifecycle management. For a deep dive into the compiler's design, see ARCHITECTURE.md.

  • Compilation:
    • OpenAPI → Python: Generate idiomatic native models, network routes, client SDKs, and boilerplate directly from OpenAPI (.json / .yaml) specifications.
    • Python → OpenAPI: Statically parse existing Python source code and emit compliant OpenAPI specifications.
  • AST-Driven & Safe: Employs static analysis instead of unsafe dynamic execution or reflection, allowing it to safely parse and emit code even for incomplete or un-compilable project states.
  • Seamless Sync: Keep your docs, tests, database, clients, and routing in perfect harmony. Update your code, and generate the docs; or update the docs, and generate the code.

Uncommon Features:

cdd-python-all supports standard CDD features.

CLI Options

Usage: cdd-python-all [OPTIONS] <COMMAND>

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.