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

Installation

Install from PyPI:

pip install axis-synome

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

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


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.dev15.tar.gz (72.6 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.dev15-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for axis_synome-0.1.0.dev15.tar.gz
Algorithm Hash digest
SHA256 aa75a1db0d4775999698ea83d8ccdb3b517e0b10a68b08effcca68239db47e43
MD5 aa36da6dcdea3bb92c84bc6ea50772c4
BLAKE2b-256 9213fe00acb8be2b80c9672b0347d267b8f2d69bd523a3fdfdb03dfe562259d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for axis_synome-0.1.0.dev15.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.dev15-py3-none-any.whl.

File metadata

File hashes

Hashes for axis_synome-0.1.0.dev15-py3-none-any.whl
Algorithm Hash digest
SHA256 39a69d70465a5544d622e6b94e6b6baab430582d93c6934d86354fa700e5448a
MD5 40483c4e34d47a584f3ca997f3eab8ca
BLAKE2b-256 97336df70254d4c03fa1a1e2549429f1b44ecab4bf8a022af4d500b6cceb2f2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for axis_synome-0.1.0.dev15-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