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.dev25206189205.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.dev25206189205-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for axis_synome-0.1.0.dev25206189205.tar.gz
Algorithm Hash digest
SHA256 aeadf14dda1d39a420028a6d5d36b36e6d2c341558396b798d9c0a5ed295f1b8
MD5 c2dcd46b205c0a534599adea07521871
BLAKE2b-256 58d9076cfb075d615b67c2e328301b8a79f82b56c96f5d1ed8a8ba234ebe4631

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for axis_synome-0.1.0.dev25206189205-py3-none-any.whl
Algorithm Hash digest
SHA256 183a87f7513852b31b91ba535f41227696100f60726002796dd74c9abe894ddc
MD5 ea5d20ede24f99535f3016ee9502cc7b
BLAKE2b-256 0a77e6b5dbdf72bb51a594db0564cf8182c1b80327a8c2fe1b8c2b1f518626a3

See more details on using hashes here.

Provenance

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