Skip to main content

Financial markets ORM, engines, and application management extensions for Main Sequence.

Project description

Main Sequence Logo

MainSequence Markets

Docs License Python Package Open Issues Last Commit Maintained

ms-markets is the financial markets extension layer for the Main Sequence platform. It provides reusable market-domain ORM models, market DataNodes, portfolio construction utilities, repository operations, and application-facing helpers for building financial systems on top of Main Sequence. Portfolio and QuantLib-backed pricing capabilities are packaged as separate import surfaces so core msm stays focused on shared markets primitives.

The Python distribution is named ms-markets. The core import package is intentionally short:

import msm

Portfolio workflows import from msm_portfolios. Optional QuantLib-backed pricing imports from msm_pricing.

Project Status

The initial core package was migrated from mainsequence-sdk/mainsequence/markets into this repository under src/msm. Architecture and implementation decisions are tracked in Architecture Decision Records.

What This Repository Contains

Main package areas:

  • msm.api.accounts: account identity and account target assignment row APIs
  • msm.api.calendars: calendar identity, date, session, and event row APIs
  • msm.api: user-facing Pydantic row objects and typed class methods for markets MetaTable records
  • msm.constants: static built-in keys such as asset type constants used across applications and examples
  • msm.client: client-facing Main Sequence market models and API wrappers
  • msm.data_nodes: market DataNode contracts, including account holdings, execution events, asset snapshots, and asset pricing details
  • msm.api.execution: order managers, target quantities, orders, events, trades, and execution error row APIs
  • msm.models: SQLAlchemy market-domain *Table declarations and MetaTable registration order
  • msm_portfolios: portfolio configuration, signal weights, rebalance strategies, virtual funds, and Virtual Fund Builder workflows
  • msm_pricing: optional QuantLib-backed instruments, curves, fixings, and pricing helpers installed with the pricing extra
  • msm.repositories: compiled persistence operations over market-domain models
  • msm.services: application-level orchestration over repositories, including asset lookup and OpenFIGI service helpers
  • msm CLI: package maintenance helpers such as explicit agent-skill copying and SDK-managed MetaTable migration commands

Repository areas:

  • docs/: MkDocs documentation, tutorials, knowledge guides, ADRs, and API reference scaffold
  • examples/msm/: core assets, accounts, calendars, platform, and row-workflow examples
  • examples/msm_portfolios/: single portfolio construction example with index linkage and canonical portfolio DataNodes
  • examples/msm_pricing/: optional pricing and QuantLib-backed examples
  • .agents/skills/ms_markets/: source agent skills for market-domain workflows
  • tests/: automated tests

Documentation Map

The documentation is organized into four reading modes:

  1. Tutorial: guided learning material
  2. Knowledge: concept-oriented guides for each msm package area
  3. Architecture: ADRs that record implementation decisions
  4. Reference: generated API reference scaffold

Recommended entry points:

Quick Start

Install the package from this repository in editable mode:

python -m pip install -e ".[dev]"

Or with uv:

uv sync --extra dev

Install pricing support only when needed:

uv sync --extra pricing

Install portfolio workflow support only when needed:

uv sync --extra portfolios

Install the project-level FastAPI surface only when needed:

uv sync --extra public_api

Verify the core import:

python -c "import msm; print(msm.__version__)"

After installing the pricing extra, verify the optional pricing import:

python -c "import msm_pricing; print(msm_pricing.FixedRateBond)"

Copy the packaged ms-markets skills into a host Main Sequence project only when you explicitly want them available to agents in that project:

msm copy-msm-skills --path /path/to/project

Importing msm never mutates the current directory or auto-copies skills. The command writes only to <project>/.agents/skills/ms_markets/ and leaves unrelated .agents content alone. Use --dry-run or --json to inspect the copy plan.

Common Development Commands

Run tests:

pytest

Run focused linting for optional pricing:

ruff check src/msm_pricing

Serve the docs locally:

mkdocs serve

Build the docs:

mkdocs build --strict

Build the package:

uv build

Publish a tagged release to PyPI:

git tag v0.0.2
git push origin v0.0.2

Pushing a v* tag triggers .github/workflows/publish-to-pypi.yml, which builds the distribution and publishes it to PyPI through GitHub Actions using trusted publishing for the repository pypi environment.

Core Dependencies

Runtime dependencies are declared in pyproject.toml. The core stack starts with:

  • mainsequence for platform integration
  • SQLAlchemy for market-domain ORM models
  • pydantic for typed configuration and serialized row contracts
  • pandas and numpy for tabular market data

Optional extras provide documentation, development, portfolio, public API, pricing, and Streamlit UI tooling. The portfolios extra installs portfolio-only helpers such as pandas-market-calendars. The public_api extra installs FastAPI and Uvicorn for the project-level apps/v1 surface. The pricing and pricing-streamlit extras install QuantLib and the optional pricing runtime exposed as msm_pricing.

Package Metadata

Project metadata is defined in pyproject.toml.

License

This project is open source under the Apache License 2.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

ms_markets-0.0.49.tar.gz (561.6 kB view details)

Uploaded Source

Built Distribution

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

ms_markets-0.0.49-py3-none-any.whl (427.5 kB view details)

Uploaded Python 3

File details

Details for the file ms_markets-0.0.49.tar.gz.

File metadata

  • Download URL: ms_markets-0.0.49.tar.gz
  • Upload date:
  • Size: 561.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ms_markets-0.0.49.tar.gz
Algorithm Hash digest
SHA256 768fd7faad79c805e3fcb4ae51fbc350b08067496903d633a9fdb9a7a2604d63
MD5 e9ab0c1116e47d3625a8e7f96f76c11f
BLAKE2b-256 1984c8c67c24bfd6dd876b9a68028758d6437051f68abbf31422a81aeae30979

See more details on using hashes here.

Provenance

The following attestation bundles were made for ms_markets-0.0.49.tar.gz:

Publisher: publish-to-pypi.yml on mainsequence-projects/MainSequenceMarkets

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

File details

Details for the file ms_markets-0.0.49-py3-none-any.whl.

File metadata

  • Download URL: ms_markets-0.0.49-py3-none-any.whl
  • Upload date:
  • Size: 427.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ms_markets-0.0.49-py3-none-any.whl
Algorithm Hash digest
SHA256 a260f7e5d653f96ab29b66321428ffcd4cdd2e6627db063f3a96b5045346f731
MD5 c01c7ca73e225b977cf1dee0fc0f042e
BLAKE2b-256 781505041a29568dd7b02728c1a0f4f482f48d5b572856a421c5b3bc680887a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for ms_markets-0.0.49-py3-none-any.whl:

Publisher: publish-to-pypi.yml on mainsequence-projects/MainSequenceMarkets

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