Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Athena: Sanity Checking Framework

PythonVersion PyPi License Documentation Status

Athena is a versatile sanity checking framework designed to simplify the process of creating and running validation procedures, known as Sanity-Check. These checks can be executed in any software environments with Python interpreters, especially in DCC (Digital Content Creation) software, or in standalone across all operating systems.

Documentation

Full documentation, including API reference and guides, is available on Read the Docs.

Getting Started

To quickly get started with Athena, follow these steps:

Prerequisites

Ensure you have Python 3.8+ installed. Athena has no external dependencies.

Installing

You can install Athena using pip:

pip install athena-sanity

Or download the latest release here.

Usage Example

You can load a Blueprint and run all it's processes, or query one single process to run: When part of a Blueprint, a Process can have extra configuration to modify it's behavior or interaction with other processes within the blueprint.

from athena import atCore

register = atCore.AtSession().register
register.load_blueprint_from_python_import_path('athena.examples.blueprint.exampleBlueprint')
blueprint = register.blueprint_by_name('exampleBlueprint')
# processor = blueprint.processor_by_name('exampleProcess')  # To get a single `Processor` from the `Blueprint`.

for processor in blueprint.processors:
    result = processor.check()
    
    for container in result:
        print(container, container.status)
        for feedback in container:
            print('\t' + str(feedback))

Alternatively, you can skip the blueprint and just run a process with a default configuration or use your own by passing extra arguments to the Processor:

from athena import atCore

# The `Processor` takes full import path to the `Process` class. The same way you'd define it in the `Blueprint`.
processor = atCore.Processor('athena.examples.process.exampleProcess.AthenaExampleProcess')

result = processor.check()
for container in result:
    print(container, container.status)
    for feedback in container:
        print('\t' + str(feedback))

You can find examples on how to write a Process or Blueprint here

Running the Tests

Full support for unit test will come later.

Versioning

Athena follows the principles of Semantic Versioning (SemVer). Check the tags on this repository for available versions.

Authors

  • Gregory Pijat - Author - GitHub

See the list of contributors who participated in this project.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

More

For an enhanced experience, check out the available UI on Gumroad. (Available soon)

Metadata

Release files for athena-sanity 0.3.0b1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for athena-sanity 0.3.0b1
File Size Uploaded Provenance Actions
athena_sanity-0.3.0b1.tar.gz 63.9 kB With provenance Details for athena_sanity-0.3.0b1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for athena-sanity 0.3.0b1
File Interpreter ABI Platform Actions
athena_sanity-0.3.0b1-py3-none-any.whl Python 3 none any Details for athena_sanity-0.3.0b1-py3-none-any.whl

Total release size: 132.2 kB

Release files / athena_sanity-0.3.0b1.tar.gz

Download URL athena_sanity-0.3.0b1.tar.gz
Size 63.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7efb6d8e5fb28743d218d1d6c79fea0e85394c162754e6680479db4929c5822f
BLAKE2b-256 checksum
How to use checksums
1d7f76ed4f34fbf81e58e9f18b17aec1982050c2fc25b187209f0132be597f24
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Release files / athena_sanity-0.3.0b1-py3-none-any.whl

Download URL athena_sanity-0.3.0b1-py3-none-any.whl
Size 68.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
446a403f3d88c0f3571831a6c68ed94a1742402a74ba21d810e3e5aed0cc0fbc
BLAKE2b-256 checksum
How to use checksums
ddedf62511461d8feebaa19cf87cc76abdc92f9e62927ed542d6a54e59baf192
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Security for athena-sanity 0.3.0b1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for athena_sanity-0.3.0b1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page