Skip to main content

ai-circus

A Building Block for Generative AI Applications with state-of-the-art performance.


Contributor Covenant

Package Information

PyPI Package Supported Python Versions


Tools and Frameworks

Python uv Ruff Pyright Pytest Pre-commit


Setup

To properly set up your machine for development, follow these steps. These steps are designed for Debian/Ubuntu-based systems. Execute these commands in the root folder of the cloned project.

One-Time Setup

  1. Sudo Setup:

    sudo ./.devcontainer/setup_sudo.sh
    

    This script configures sudo and installs essential base packages.

  2. User Setup:

    ./.devcontainer/setup_user.sh
    

    This script configures the user environment, installs uv, cookiecutter, and pre-commit, customizes the prompt, and sets up aliases.

  3. Update Terminal:

    source ~/.bashrc
    

    Apply the changes made by the user setup script to your current terminal session.

Project Setup

After the one-time setup, use the setup macro to ensure the Python environment for the project is correctly recreated and synced (it also executes the below make qa command).

setup

This command performs the following actions:

  • Checks and activates the virtual environment.
  • Syncs project dependencies using uv.
  • Installs pre-commit hooks if not already installed and runs them (make qa)

Contributing

With the environment set up, you can use tools like make to contribute to the project.

  • Quality Assurance:

    make qa
    

    Runs quality assurance checks, including whitespace trimming, line ending fixes, TOML/YAML/JSON checks, merge conflict checks, Ruff, Pyright, and Bandit.

  • Build:

    make build
    

    Executes the build process for the project.

Contributing Guidelines:

  • Review our Style Guide to ensure clear and descriptive commit messages and consistent coding standards.
  • See our Contribution Guidelines for details on the workflow and submission process.
  • Please abide by our Code of Conduct to help maintain a welcoming and collaborative community.

Metadata

Release files for ai-circus 0.1.1

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

Source distribution (sdist)

Source distribution for ai-circus 0.1.1
File Size Uploaded Provenance Actions
ai_circus-0.1.1.tar.gz 34.6 kB Without provenance Details for ai_circus-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ai-circus 0.1.1
File Interpreter ABI Platform Actions
ai_circus-0.1.1-py3-none-any.whl Python 3 none any Details for ai_circus-0.1.1-py3-none-any.whl

Total release size: 54.7 kB

Release files / ai_circus-0.1.1.tar.gz

Download URL ai_circus-0.1.1.tar.gz
Size 34.6 kB
Tags Source
SHA-256 checksum
How to use checksums
bf214b1e2328b9ba5fc4cc67def0ca458f4100acad96c6431903ae24178baee6
BLAKE2b-256 checksum
How to use checksums
b5577211205d1af98bfdff51ea691cf78caf5880c80e61a1262d3eccca937364
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / ai_circus-0.1.1-py3-none-any.whl

Download URL ai_circus-0.1.1-py3-none-any.whl
Size 20.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
27d10d1575405ac6e554ac58051b7da3ca1e8cab5aff53a59011a98380df8588
BLAKE2b-256 checksum
How to use checksums
7b430d02b828ae1c3d083fcb0e820f18aa09ed299d561b2060c717ee0bf9880d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Security for ai-circus 0.1.1

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

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