Metadata-Version: 2.4
Name: cineon-api-format
Version: 3.0.0
Summary: A shared repository that describes the types used by the ELE-api, and other Cineon apis.
Requires-Python: >=3.12
Requires-Dist: cineon-format<4,>=3.0.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: typeguard>=4.4.4
Description-Content-Type: text/markdown

# Python repository template

![Latest Release](badges/version.svg) ![Coverage Status](badges/coverage.svg) ![Code complexity](badges/complexity.svg)

This serves as an example of how to set up a new Python project.

You should update this `README` to be specific to your project. You should update `pyproject.toml` with the name of your project and rename the `src/repository_template` directory to be appropriate for your project.

## Run the example

A simple "Hello World" example can be run using:

```bash
uv run scripts/example.py
```

## Set up the hooks

These pre-push hooks ensure that the formatter is run and the badges are updated every time you attempt to `git push`. This way formatting errors are caught and be corrected before they reach the GitHub continuous-integration (CI) step. The badges are then automatically up-to-date.

```bash
git config --local core.hooksPath .githooks/
```

## Check the formatting

The formatting can be checked manually using:

```bash
./scripts/format.sh
```

this is exactly the script that is run in the CI pipeline and the pre-push hook. Formatting uses `Prettier` for markdown, `shfmt` for shell scripts, and `ruff` for Python.

## Run the tests

The tests can be run manually using:

```bash
./scripts/test.sh
```
