Metadata-Version: 2.4
Name: pyawe-ctrl-io
Version: 1.0.0
Summary: Tool for handling AWE control vector interfaces (codegeneration)
Project-URL: AudioWeaver, https://w.dspconcepts.com/audio-weaver
Project-URL: Documentation, https://w.dspconcepts.com/docs
Project-URL: Homepage, https://w.dspconcepts.com/audio-weaver
Author-email: Volker Springer <vspringer@dspconcepts.com>
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: jinja2==3.1.4
Requires-Dist: pip
Requires-Dist: pkginfo
Requires-Dist: pydantic>=2.10
Requires-Dist: pyyaml~=6.0.1
Requires-Dist: twine
Requires-Dist: wheel
Provides-Extra: doc
Requires-Dist: gitpython; extra == 'doc'
Requires-Dist: hatch-vcs; extra == 'doc'
Requires-Dist: markdown-exec~=1.10.0; extra == 'doc'
Requires-Dist: mkdocs-macros-plugin~=1.3.7; extra == 'doc'
Requires-Dist: mkdocs-material~=9.5.49; extra == 'doc'
Requires-Dist: mkdocs-monorepo-plugin~=1.1.0; extra == 'doc'
Requires-Dist: mkdocs-with-pdf; extra == 'doc'
Requires-Dist: mkdocstrings[python]~=0.27.0; extra == 'doc'
Requires-Dist: qrcode; extra == 'doc'
Description-Content-Type: text/markdown

# pyawe-ctrl-io

## Description

**pyawe_ctrl_io** is a Python package to generate code for control vector definitions
and AWE design's audio channel maps.

## Installation

`(venv) pip install pyawe_ctrl_io`

## Documentation

After installation, use `awe-showhelp` to read the documentation contained in the package.

## Usage

### Code Generation

Once the package is installed in a Python environment:

- `(venv) awectrl-codegen -h` - to see how to use
- `(venv) awectrl-codegen spec-file.yml` - generated code for a specific IO specification
- `(venv) awectrl-codegen spec-file.yml -awd design.awd` - use interface spec in conjunction with a design file

**NOTE**: 

It is possible to generate code in various target programming languages:

- `(venv) awectrl-codegen -l DEBUG -o src\generated` // Python code
- `(venv) awectrl-codegen -l DEBUG --lang C -o src\tests\c\test_vectorgen\ctrlvector\_generated` // C code 

For Python, it is possible to create an (installable) wheel file:

- `(venv) awectrl-createwheel spec-file.yml -n MyAWEIF -v 0.1 `

Use `-u` to publish this wheel to a PyPi server.

### Using the Generated Code

- for C: checkout `src/tests/c/README.md` and follow instructions there
- for Python: see `./src/tests/python` for more info
