Metadata-Version: 2.4
Name: axis-synome
Version: 0.1.dev186
Summary: Axis specification modules (entities, formulas, validators)
Project-URL: Repository, https://github.com/archon-research/next-gen-atlas
Project-URL: Documentation, https://github.com/archon-research/next-gen-atlas
Author-email: Archon Tech <hello@archontech.ai>
License: MIT
Requires-Python: >=3.11
Requires-Dist: eth-hash[pycryptodome]>=0.5.0
Requires-Dist: pydantic>=2.0.0
Description-Content-Type: text/markdown

# axis

[![Publish axis to GitHub Packages](https://github.com/archon-research/synome/actions/workflows/publish-axis.yml/badge.svg?branch=main)](https://github.com/archon-research/synome/actions/workflows/publish-axis.yml)

Axis specification modules for Synome, including:
- **ASC** (Actively Stabilizing Capital) specification with entities and formulas
- **Validators** for spec validation and static analysis (flake8 plugin)
- **Metadata** utilities for formula documentation

## Installation

```bash
pip install axis --index-url https://npm.pkg.github.com/archon-research
```

## Usage

### Entities

```python
from axis_synome.spec.asc.entities import YourEntity
```

### Formulas

```python
from axis_synome.spec.asc.formulas import your_formula
```

### Validators (Flake8)

The spec validator is provided as a flake8 plugin (`AXS`) that validates specification files against the allowed Python subset.

```bash
flake8 --select=AXS your_spec.py
```

## About

Axis is a specification framework for defining financial and risk calculations. The ASC (Actively Stabilizing Capital) module is a concrete implementation following the Axis specification pattern.

For more information on writing specifications, see [WRITING_SPECS.md](WRITING_SPECS.md).

## Requirements

- Python >= 3.11
- pydantic >= 2.0.0
