Skip to main content

Axis specification modules (entities, formulas, validators)

Project description

axis-synome

A Python framework for defining and validating financial specifications, with a focus on DeFi primitives and risk calculations. Includes:

  • ASC Specifications — Actively Stabilizing Capital entities (assets, tokens, networks, protocols) and formulas (collateral ratios, incentives, resting/latent ASC)
  • Spec Validator — Flake8 plugin for enforcing Python subset constraints on spec files
  • Metadata & Utilities — Support for spec documentation and validated dataclasses
  • SpecRuntime — Pluggable runtime abstraction for opaque operations (linear interpolation, ...) that specs can call without depending on a specific implementation library

Installation

Install from PyPI:

pip install axis-synome

To enable the built-in ReferenceSpecRuntime (numpy-backed), install with the runtime extra:

pip install axis-synome[runtime]

Or install from a private registry:

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

Usage

ASC Entities

from axis_synome.spec.asc.entities import primes, tokens, networks, protocol_sets

ASC Formulas

from axis_synome.spec.asc.formulas import asc, asc_collateral_ratio, asc_incentive

Opaque Operations in Specs

from axis_synome.spec_support.runtime import math

values = math.linear_interp([1.5], [1.0, 2.0], [10.0, 20.0])  # -> [15.0]

The active runtime is selected once at import time. Resolution order:

  1. AXIS_SYNOME_SPEC_RUNTIME=module.path:ClassName env var
  2. A registered axis_synome.spec_runtimes entry point (declared by a consumer package's pyproject.toml)
  3. The bundled ReferenceSpecRuntime (requires axis-synome[runtime])

If none is available, importing axis_synome.spec_support.runtime.math raises ImportError — the runtime is required at import time, not on first call.

Spec Validation

from axis_synome.spec_validator import validate_file

validate_file("my_spec.py")

Or use as a flake8 plugin:

flake8 --select=AXS your_spec.py

About

axis-synome is a specification framework for defining financial and risk calculations in DeFi, with emphasis on formalized, auditable spec files.

For more information on writing specifications, see WRITING_SPECS.md.

Requirements

  • Python >= 3.11
  • pydantic >= 2.0.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

axis_synome-0.1.0.dev61.tar.gz (171.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

axis_synome-0.1.0.dev61-py3-none-any.whl (112.6 kB view details)

Uploaded Python 3

File details

Details for the file axis_synome-0.1.0.dev61.tar.gz.

File metadata

  • Download URL: axis_synome-0.1.0.dev61.tar.gz
  • Upload date:
  • Size: 171.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for axis_synome-0.1.0.dev61.tar.gz
Algorithm Hash digest
SHA256 d47092e771df1aacd15314c6ee847cf759368b5e69d19611a919dfae8d339462
MD5 1f2fa3231d463ca412973f1e0988b0b9
BLAKE2b-256 d3151689d2e8c97045fe3783c003e05d827e10072caa8077b5e9e1db8ac75a62

See more details on using hashes here.

Provenance

The following attestation bundles were made for axis_synome-0.1.0.dev61.tar.gz:

Publisher: publish-axis.yml on archon-research/next-gen-atlas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file axis_synome-0.1.0.dev61-py3-none-any.whl.

File metadata

File hashes

Hashes for axis_synome-0.1.0.dev61-py3-none-any.whl
Algorithm Hash digest
SHA256 2bb8f6812874df9a080c657bf43d9dbaa48855974e97d956710236b7f4283ff8
MD5 20ee7ef49a650d4c8722f48ef7c556de
BLAKE2b-256 09e8fa802f23635c2e6667875646a0d47786bf0f24c03ddb14ef68a9b750e75c

See more details on using hashes here.

Provenance

The following attestation bundles were made for axis_synome-0.1.0.dev61-py3-none-any.whl:

Publisher: publish-axis.yml on archon-research/next-gen-atlas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page