Skip to main content

Educational multi-process trading system with order matching

Project description

EduMatcher

Learn how real trading systems work. Build it from first principles.

Category Link
Package PyPI version Python 3.13+
Documentation Documentation
License License: MIT
Release GitHub release
CI/CD Coverage
Code Quality Code style: black Checked with mypy Linting: flake8
Repo URL GitHub

EduMatcher is an educational trading system that teaches market microstructure, matching logic, and exchange architecture through runnable code.

Unlike toy examples, it is designed to be both understandable and fast.

Quick Start

Bootstrap a new session directory and either generate engine_config.yaml with sane defaults, or start from the sample config copied by pm-setup:

pm-setup
pm-config-gen --symbols AAPL MSFT --gateways TRADER01 TRADER02 OPS01:ADMIN --sessions-enabled --output engine_config.yaml
pm-engine --verbose

Alternative: skip pm-config-gen and edit the sample engine_config.yaml that pm-setup already placed in your working directory.

If you run from source, prefix commands with poetry run.

Why EduMatcher?

  • Real exchange mechanics: order books, auctions, clearing, and risk controls
  • Multi-process architecture: gateway, engine, audit, clearing, stats, and tooling
  • Performance-aware implementation: ~60,000 orders/second with microsecond latency
  • Practical protocol design: ALF (ALmost Fix) command language for gateway order entry
  • Strong engineering discipline: type hints, linting, and high test coverage

Key Features

  • Complete lifecycle: order entry, matching, clearing, and audit trail
  • Rich order support: MARKET, LIMIT, STOP, STOP_LIMIT, IOC/FOK, ICEBERG, combo, OCO
  • Market mechanisms: opening/closing auctions and circuit breakers
  • Config-driven behavior via engine_config.yaml which acts as reference data for EduMatcher
  • Message-based process boundaries with strong observability
  • Implement real risk controls such as prioce-collar, kill-switch, circuit-breaker, and mass-cancel

Key Limitations

  • No spread-order books
  • No implied (synthetic) orders
  • No primary-secondary site failover
  • No load balancing
  • Limited replay for participants that lose the connection
  • No index calculations

Performance

EduMatcher does not aim to match venues like NYSE or LSE, but it is still fast for a pure Python educational project.

Latency (engine-only, n=1,000 each)

Order type min (µs) median (µs) P80 (µs) P90 (µs) max (µs)
Limit 8.1 8.5 9.6 10.0 18
Market 8.1 8.5 8.8 9.3 45

Throughput

Metric Value
Max TPS ~60,000 orders/second
Order mix 20% Market, 30% aggressive Limit, 50% passive Limit

Performance note: price-collar and circuit-breaker checks run in the hot path for every match. They are required for realistic risk control and add measurable cost.

Explore the Code

Start with these key areas:

Documentation

Full docs: EduMatcher Documentation

Additional references:

  • How an Exchange Works. This is a generic document meant for SW developers with no previous financial experience. Reading this document will give the necessary background both in finance and the core workings of an exchange.
  • ALF Protocol Appendix. ALF is the Gatewauy human protocol used to send in orders vi the ALF gateway. It is a drastically simplified FIX inspired protocol (ALF = ALmost Fix)
  • Glossary. An extensiv glossary with all commonly used financial terms used in these documents.

Who It's For

  • Computer science students learning systems design and concurrency
  • Finance students learning market microstructure and trading mechanics
  • Developers building exchange technology or trading systems
  • Anyone curious about how modern markets actually work

Contributing

This is an educational project. If you find bugs, improve the documentation, or make other enhancements PRs are welcome!

Citation

If you use this tool in teaching or courses, please cite:

@software{edumatcher,
  title = {EduMatcher},
  author = {Johan Persson},
  year = {2026},
  url = {https://github.com/johan162/edumatcher},
  version = {0.9.1}
}

License

MIT License - see LICENSE.

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

edumatcher-0.9.1.tar.gz (161.3 kB view details)

Uploaded Source

Built Distribution

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

edumatcher-0.9.1-py3-none-any.whl (193.5 kB view details)

Uploaded Python 3

File details

Details for the file edumatcher-0.9.1.tar.gz.

File metadata

  • Download URL: edumatcher-0.9.1.tar.gz
  • Upload date:
  • Size: 161.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure

File hashes

Hashes for edumatcher-0.9.1.tar.gz
Algorithm Hash digest
SHA256 2666940d3fa285d2d9fb338490b077e5e3c79069a4ea52464b5f999a93fdafdd
MD5 b27a790e0ae31e33e2ad98343e2492dc
BLAKE2b-256 34dc0e7cda919627c43208e5640d2e0cec72c8f9e8d7e3acd85420fc48ad2d32

See more details on using hashes here.

File details

Details for the file edumatcher-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: edumatcher-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 193.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1018-azure

File hashes

Hashes for edumatcher-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 43ca5e300a1f5d87b39990fd5522c1acbdfa0ecd63de786147260975e83bdb4a
MD5 6d7e8c6f0dd7f85c8e13a56cd95b5192
BLAKE2b-256 7a1eab993c50316566f293e306eddf6ff49cd8c7f637a71a896560982e3a1d95

See more details on using hashes here.

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