synpath 0.1.0__tar.gz → 0.3.1__tar.gz

synpath-0.3.1/Cargo.toml

@@ -0,0 +1,19 @@
+# The Rust core under the Python API.
+#
+#   crates/synpath-core   pure Rust: no I/O, no Python. The hot paths live here.
+#   bindings/python       PyO3 wrappers, built by maturin into `synpath._core`.
+#
+# Every piece here has a pure-Python twin in `synpath/`, and the test suite runs
+# against both, so the two cannot drift apart.
+[workspace]
+members = ["crates/synpath-core", "bindings/python"]
+resolver = "2"
+
+[workspace.package]
+edition = "2021"
+license = "MIT"
+repository = "https://github.com/Synpath-ai/synpath"
+
+[profile.release]
+lto = "fat"
+codegen-units = 1

{synpath-0.1.0 → synpath-0.3.1}/PKG-INFO

@@ -1,70 +1,68 @@
-Metadata-Version: 2.5
+Metadata-Version: 2.4
 Name: synpath
-Version: 0.1.0
-Summary: One API for prediction markets. Kalshi and Polymarket, normalized, with every price labelled by source and time.
-Project-URL: Homepage, https://synpath.dev
-Project-URL: Documentation, https://synpath.dev/docs
-Project-URL: Repository, https://github.com/Synpath-ai/synpath
-Project-URL: Issues, https://github.com/Synpath-ai/synpath/issues
-Project-URL: Discord, https://discord.gg/QZzsHTpGA3
-Author: Synpath
-License: MIT
-License-File: LICENSE
-Keywords: kalshi,market-data,polymarket,prediction-markets,trading,unified-api
+Version: 0.3.1
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Office/Business :: Financial
-Requires-Python: >=3.10
-Requires-Dist: aiosqlite>=0.20
-Requires-Dist: cryptography>=42
-Requires-Dist: eth-account>=0.13
-Requires-Dist: fastapi>=0.110
 Requires-Dist: httpx>=0.27
 Requires-Dist: pydantic>=2.6
+Requires-Dist: cryptography>=42
+Requires-Dist: eth-account>=0.13
 Requires-Dist: pyjwt[crypto]>=2.8
-Requires-Dist: tomli>=2.0; python_version < '3.11'
-Requires-Dist: uvicorn[standard]>=0.27
 Requires-Dist: websockets>=13
+Requires-Dist: aiosqlite>=0.20
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn[standard]>=0.27
+Requires-Dist: tomli>=2.0 ; python_full_version < '3.11'
+Requires-Dist: pytest>=8 ; extra == 'dev'
+Requires-Dist: respx>=0.21 ; extra == 'dev'
+Requires-Dist: anyio>=4 ; extra == 'dev'
+Requires-Dist: synpath[grpc] ; extra == 'dev'
+Requires-Dist: grpcio>=1.60 ; extra == 'grpc'
+Requires-Dist: grpcio-tools>=1.60 ; extra == 'grpc'
+Requires-Dist: protobuf>=5.26 ; extra == 'grpc'
+Requires-Dist: pyjwt[crypto]>=2.8 ; extra == 'grpc'
+Requires-Dist: cryptography>=42 ; extra == 'grpc'
 Provides-Extra: dev
-Requires-Dist: anyio>=4; extra == 'dev'
-Requires-Dist: cryptography>=42; extra == 'dev'
-Requires-Dist: grpcio-tools>=1.60; extra == 'dev'
-Requires-Dist: grpcio>=1.60; extra == 'dev'
-Requires-Dist: protobuf>=5.26; extra == 'dev'
-Requires-Dist: pyjwt[crypto]>=2.8; extra == 'dev'
-Requires-Dist: pytest>=8; extra == 'dev'
-Requires-Dist: respx>=0.21; extra == 'dev'
 Provides-Extra: engine
 Provides-Extra: grpc
-Requires-Dist: cryptography>=42; extra == 'grpc'
-Requires-Dist: grpcio-tools>=1.60; extra == 'grpc'
-Requires-Dist: grpcio>=1.60; extra == 'grpc'
-Requires-Dist: protobuf>=5.26; extra == 'grpc'
-Requires-Dist: pyjwt[crypto]>=2.8; extra == 'grpc'
 Provides-Extra: server
 Provides-Extra: trading
 Provides-Extra: ws
-Description-Content-Type: text/markdown
+License-File: LICENSE
+Summary: One API for prediction markets. Kalshi and Polymarket, normalized, with every price labelled by source and time.
+Keywords: prediction-markets,kalshi,polymarket,unified-api,trading,market-data
+Author: Synpath
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Discord, https://synpath.dev/discord
+Project-URL: Documentation, https://synpath.dev/docs
+Project-URL: Homepage, https://synpath.dev
+Project-URL: Issues, https://github.com/Synpath-ai/synpath/issues
+Project-URL: Repository, https://github.com/Synpath-ai/synpath
 
 <div align="center">
 
 <img src="https://raw.githubusercontent.com/Synpath-ai/synpath/main/assets/synpath-banner.png" alt="Synpath: one API for every prediction market" width="100%">
 
-# Synpath – One API for prediction markets
+# Synpath – One API for prediction markets <a href="https://x.com/Synpath_Dev"><img src="https://img.shields.io/twitter/url?url=https%3A%2F%2Fx.com%2FSynpath_Dev&style=social&label=Follow" alt="Follow @Synpath_Dev on X" height="28"></a>
 
 **Build on prediction markets without building against each one.**<br/>
-One open-source API across Kalshi, Polymarket and Polymarket US: market data, order entry, live streams, and an execution engine that remembers what it sent. In-process from Python, over REST and WebSocket from anywhere.
+One open-source API across Kalshi, Polymarket, Polymarket US and Opinion: market data, order entry, live streams, and an execution engine that remembers what it sent. In-process from Python, over REST and WebSocket from anywhere.
 
 <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
-<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10%2B-blue.svg" alt="Python 3.10+"></a>
-<a href="https://discord.gg/QZzsHTpGA3"><img src="https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
+<a href="https://pepy.tech/projects/synpath"><img src="https://img.shields.io/pepy/dt/synpath?label=Total%20Downloads&color=blue" alt="Total Downloads"></a>
+<a href="https://synpath.dev/discord"><img src="https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
 
 </div>
 
-**🆕 New: Every Kalshi order book, every tick.**<br/>
-Full-depth books and trades for every past Kalshi trade. Query any moment in under a minute. **[Get the data →](https://synpath.dev/tick-data)**
+**🆕 New: Smart order routing across Kalshi and Polymarket.**<br/>
+One order, both order books combined, filled from the cheapest price after fees. **[See how it works →](https://www.synpath.dev/docs/concepts/buckets)**
+
+⭐ **If Synpath saves you time, [star it on GitHub](https://github.com/Synpath-ai/synpath).** It's how other traders find it.
 
 ---
 
@@ -75,10 +73,11 @@ Full-depth books and trades for every past Kalshi trade. Query any moment in und
 | <img src="assets/kalshi.png" width="20" height="20" alt="Kalshi"> | [Kalshi](https://kalshi.com) | `kalshi` | ✓ | ✓ | WebSocket | one book per market, both sides read it |
 | <img src="assets/polymarket.png" width="20" height="20" alt="Polymarket"> | [Polymarket](https://polymarket.com) | `polymarket` | ✓ | ✓ | WebSocket | one book per outcome token |
 | <img src="assets/polymarket.png" width="20" height="20" alt="Polymarket US"> | [Polymarket US](https://polymarket.us) | `polymarket_us` | ✓ | ✓ retail and exchange APIs | WebSocket and gRPC | one book per market, both sides read it |
+| | [Opinion](https://opinion.trade) | `opinion` | ✓ | ✓ not yet live-tested | WebSocket (API key) | one book per outcome token |
 
 ## Why Synpath
 
-- **Liquidity is fragmented. Your time shouldn't be.** The same market trades on Kalshi, Polymarket and Polymarket US, each with its own API, units and quirks. Synpath gives you one interface for all of them, and smart order routing buys from whichever book is cheapest. Spend your time on alpha, not plumbing.
+- **Liquidity is fragmented. Your time shouldn't be.** The same market trades on Kalshi, Polymarket, Polymarket US and Opinion, each with its own API, units and quirks. Synpath gives you one interface for all of them, and smart order routing buys from whichever book is cheapest. Spend your time on alpha, not plumbing.
 
 - **Traders deserve advanced order types.** Stops, trailing stops, icebergs, OCO, brackets, TWAP and pegs, on every venue, even where the exchange has none. Orders are journaled before they're sent, so a crash never places one twice.
 
@@ -91,7 +90,7 @@ pip install synpath              # market data, order entry, streams, the engine
 pip install "synpath[grpc]"      # + Polymarket US exchange gRPC streams
 ```
 
-Python 3.10 or newer.
+Python 3.10 or newer. The hot paths (order books, reading the venues' book streams, order signing and the order router) run on a Rust core that ships prebuilt inside the wheel for Linux, macOS and Windows; nothing else to install.
 
 **Hosted API.** Run `synpath login`, then `synpath keys create`. It serves tick-level Kalshi order book and trade history, and cross-venue market matching. Trading stays on your machine: Synpath never holds your keys or funds.
 
@@ -124,7 +123,7 @@ fee.estimate(price=0.50, contracts=100)            # 1.75
 **Same code, every venue**
 
 ```python
-for venue_id in synpath.exchanges:                 # ['kalshi', 'polymarket', 'polymarket_us']
+for venue_id in synpath.exchanges:                 # ['kalshi', 'polymarket', 'polymarket_us', 'opinion']
     with synpath.exchange(venue_id) as venue:
         page = venue.fetch_markets(limit=5)
 
@@ -157,18 +156,26 @@ async with PolymarketMarketStream() as stream:
             print(event.market_id, event.side, event.best_bid, event.best_ask)
 ```
 
-**The engine, and the orders the venues do not hold**
+**Smart order routing: one order across Kalshi and Polymarket**
 
 ```python
-from synpath.engine import Engine, EngineConfig, RiskConfig
-from synpath import OrderType
-
-async with Engine({"kalshi": kalshi}, EngineConfig(journal_path="trading.db"),
-                  risk=RiskConfig(max_order_contracts=Decimal("100"))) as engine:
+from synpath import Bucket, BucketMember, OrderType, PolymarketTrading
+from synpath.engine import Engine, EngineConfig
+
+creds = load_credentials()
+async with KalshiTrading(require("kalshi", creds)) as kalshi, \
+           PolymarketTrading(require("polymarket", creds)) as poly, \
+           Engine({"kalshi": kalshi, "polymarket": poly}, EngineConfig(journal_path="trading.db")) as engine:
+    # The same market on both venues; flip=True where a venue asks the question the other way round
+    bucket = await engine.save_bucket(Bucket(book="alpha", name="Fed cut in December", members=[
+        BucketMember(market_id="kalshi:KXFEDDECISION-26DEC-C25"),
+        BucketMember(market_id="polymarket:2252244", flip=True),
+    ]))
+    # Both order books combined, each level net of fees, filled from the cheapest price outward
     await engine.submit(OrderRequest(
-        market_id=market.id, side=Side.SELL, amount=Decimal("20"),
-        type=OrderType.TRAILING_STOP, stop_price=Decimal("0.40"),
-        params={"trail": "0.03"}, book="alpha",
+        market_id=bucket.market_id, side=Side.BUY, amount=Decimal("500"),
+        type=OrderType.MARKET, price=Decimal("0.45"),   # the worst price you accept
+        book="alpha",
     ))
 ```
 
@@ -189,27 +196,28 @@ npx openapi-typescript openapi.json --default-non-nullable false -o src/synpath.
 
 ## Documentation
 
-- [CLI](https://synpath.dev/docs/quickstart): hosted data API sign-in and keys versus local venue trading server setup
-- [Unified API](https://synpath.dev/docs/sdks/python): methods, data structures, identifiers, paging, status, errors
-- [Capabilities](https://synpath.dev/docs/concepts/exchanges): what each venue can and cannot answer
-- [HTTP server](https://synpath.dev/docs/api-reference): routes, envelopes, typed client generation, trading routes with per-account keys, mounting behind your own auth
-- [Trading](https://synpath.dev/docs/concepts/orders): credentials, `Decimal` money, order entry on Kalshi, Polymarket and Polymarket US
-- [Streaming](https://synpath.dev/docs/ws-api-reference): WebSocket and gRPC books, trades, orders and fills as self-healing event streams
-- [Engine](docs/engine.md): a journal written before anything is sent, pre-trade risk, a ledger, reconciliation, a kill switch, the order types the venues do not hold, buckets that route one order across venues, paper trading
-- [TypeScript client](https://synpath.dev/docs/sdks/typescript): generate a typed client from the OpenAPI document, place through cancel without Python
+See the [API Reference](https://www.synpath.dev/docs) for detailed documentation and more examples.
 
 ## Development
 
 ```bash
 git clone https://github.com/Synpath-ai/synpath
 cd synpath
-pip install -e ".[dev]"
+pip install -e ".[dev]"   # builds the Rust core too: needs a Rust toolchain (rustup.rs)
 
 pytest              # offline, against recorded venue payloads
 pytest -m live      # market data against the real venues
 pytest -m demo      # order entry on a venue's demo environment
+SYNPATH_PURE_PYTHON=1 pytest   # the same tests on the pure-Python fallback
+cargo test -p synpath-core     # the Rust core on its own
 ```
 
+The Rust core lives in `crates/synpath-core` (pure Rust) and
+`bindings/python` (its PyO3 wrapper, built as `synpath._core`). Every class
+it provides has a pure-Python twin with the same interface, and the library
+uses the twin when the extension is not built. Venue adapters are plain
+Python: adding a venue needs no Rust.
+
 The `demo` tests place and cancel real orders on a demo exchange with the
 credentials in your environment, and leave the account flat. `python -m
 synpath.trading doctor` says which venues are configured without printing a
@@ -217,8 +225,9 @@ secret.
 
 ## Prior Art
 
-[ccxt](https://github.com/ccxt/ccxt) set the conventions this library follows. [pmxt](https://github.com/pmxt-dev/pmxt) got to prediction markets first.
+[ccxt](https://github.com/ccxt/ccxt) set the conventions this library follows.
 
 ## License
 
 MIT
+

{synpath-0.1.0 → synpath-0.3.1}/README.md

@@ -2,19 +2,21 @@
 
 <img src="https://raw.githubusercontent.com/Synpath-ai/synpath/main/assets/synpath-banner.png" alt="Synpath: one API for every prediction market" width="100%">
 
-# Synpath – One API for prediction markets
+# Synpath – One API for prediction markets <a href="https://x.com/Synpath_Dev"><img src="https://img.shields.io/twitter/url?url=https%3A%2F%2Fx.com%2FSynpath_Dev&style=social&label=Follow" alt="Follow @Synpath_Dev on X" height="28"></a>
 
 **Build on prediction markets without building against each one.**<br/>
-One open-source API across Kalshi, Polymarket and Polymarket US: market data, order entry, live streams, and an execution engine that remembers what it sent. In-process from Python, over REST and WebSocket from anywhere.
+One open-source API across Kalshi, Polymarket, Polymarket US and Opinion: market data, order entry, live streams, and an execution engine that remembers what it sent. In-process from Python, over REST and WebSocket from anywhere.
 
 <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
-<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10%2B-blue.svg" alt="Python 3.10+"></a>
-<a href="https://discord.gg/QZzsHTpGA3"><img src="https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
+<a href="https://pepy.tech/projects/synpath"><img src="https://img.shields.io/pepy/dt/synpath?label=Total%20Downloads&color=blue" alt="Total Downloads"></a>
+<a href="https://synpath.dev/discord"><img src="https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white" alt="Discord"></a>
 
 </div>
 
-**🆕 New: Every Kalshi order book, every tick.**<br/>
-Full-depth books and trades for every past Kalshi trade. Query any moment in under a minute. **[Get the data →](https://synpath.dev/tick-data)**
+**🆕 New: Smart order routing across Kalshi and Polymarket.**<br/>
+One order, both order books combined, filled from the cheapest price after fees. **[See how it works →](https://www.synpath.dev/docs/concepts/buckets)**
+
+⭐ **If Synpath saves you time, [star it on GitHub](https://github.com/Synpath-ai/synpath).** It's how other traders find it.
 
 ---
 
@@ -25,10 +27,11 @@ Full-depth books and trades for every past Kalshi trade. Query any moment in und
 | <img src="assets/kalshi.png" width="20" height="20" alt="Kalshi"> | [Kalshi](https://kalshi.com) | `kalshi` | ✓ | ✓ | WebSocket | one book per market, both sides read it |
 | <img src="assets/polymarket.png" width="20" height="20" alt="Polymarket"> | [Polymarket](https://polymarket.com) | `polymarket` | ✓ | ✓ | WebSocket | one book per outcome token |
 | <img src="assets/polymarket.png" width="20" height="20" alt="Polymarket US"> | [Polymarket US](https://polymarket.us) | `polymarket_us` | ✓ | ✓ retail and exchange APIs | WebSocket and gRPC | one book per market, both sides read it |
+| | [Opinion](https://opinion.trade) | `opinion` | ✓ | ✓ not yet live-tested | WebSocket (API key) | one book per outcome token |
 
 ## Why Synpath
 
-- **Liquidity is fragmented. Your time shouldn't be.** The same market trades on Kalshi, Polymarket and Polymarket US, each with its own API, units and quirks. Synpath gives you one interface for all of them, and smart order routing buys from whichever book is cheapest. Spend your time on alpha, not plumbing.
+- **Liquidity is fragmented. Your time shouldn't be.** The same market trades on Kalshi, Polymarket, Polymarket US and Opinion, each with its own API, units and quirks. Synpath gives you one interface for all of them, and smart order routing buys from whichever book is cheapest. Spend your time on alpha, not plumbing.
 
 - **Traders deserve advanced order types.** Stops, trailing stops, icebergs, OCO, brackets, TWAP and pegs, on every venue, even where the exchange has none. Orders are journaled before they're sent, so a crash never places one twice.
 
@@ -41,7 +44,7 @@ pip install synpath              # market data, order entry, streams, the engine
 pip install "synpath[grpc]"      # + Polymarket US exchange gRPC streams
 ```
 
-Python 3.10 or newer.
+Python 3.10 or newer. The hot paths (order books, reading the venues' book streams, order signing and the order router) run on a Rust core that ships prebuilt inside the wheel for Linux, macOS and Windows; nothing else to install.
 
 **Hosted API.** Run `synpath login`, then `synpath keys create`. It serves tick-level Kalshi order book and trade history, and cross-venue market matching. Trading stays on your machine: Synpath never holds your keys or funds.
 
@@ -74,7 +77,7 @@ fee.estimate(price=0.50, contracts=100)            # 1.75
 **Same code, every venue**
 
 ```python
-for venue_id in synpath.exchanges:                 # ['kalshi', 'polymarket', 'polymarket_us']
+for venue_id in synpath.exchanges:                 # ['kalshi', 'polymarket', 'polymarket_us', 'opinion']
     with synpath.exchange(venue_id) as venue:
         page = venue.fetch_markets(limit=5)
 
@@ -107,18 +110,26 @@ async with PolymarketMarketStream() as stream:
             print(event.market_id, event.side, event.best_bid, event.best_ask)
 ```
 
-**The engine, and the orders the venues do not hold**
+**Smart order routing: one order across Kalshi and Polymarket**
 
 ```python
-from synpath.engine import Engine, EngineConfig, RiskConfig
-from synpath import OrderType
-
-async with Engine({"kalshi": kalshi}, EngineConfig(journal_path="trading.db"),
-                  risk=RiskConfig(max_order_contracts=Decimal("100"))) as engine:
+from synpath import Bucket, BucketMember, OrderType, PolymarketTrading
+from synpath.engine import Engine, EngineConfig
+
+creds = load_credentials()
+async with KalshiTrading(require("kalshi", creds)) as kalshi, \
+           PolymarketTrading(require("polymarket", creds)) as poly, \
+           Engine({"kalshi": kalshi, "polymarket": poly}, EngineConfig(journal_path="trading.db")) as engine:
+    # The same market on both venues; flip=True where a venue asks the question the other way round
+    bucket = await engine.save_bucket(Bucket(book="alpha", name="Fed cut in December", members=[
+        BucketMember(market_id="kalshi:KXFEDDECISION-26DEC-C25"),
+        BucketMember(market_id="polymarket:2252244", flip=True),
+    ]))
+    # Both order books combined, each level net of fees, filled from the cheapest price outward
     await engine.submit(OrderRequest(
-        market_id=market.id, side=Side.SELL, amount=Decimal("20"),
-        type=OrderType.TRAILING_STOP, stop_price=Decimal("0.40"),
-        params={"trail": "0.03"}, book="alpha",
+        market_id=bucket.market_id, side=Side.BUY, amount=Decimal("500"),
+        type=OrderType.MARKET, price=Decimal("0.45"),   # the worst price you accept
+        book="alpha",
     ))
 ```
 
@@ -139,27 +150,28 @@ npx openapi-typescript openapi.json --default-non-nullable false -o src/synpath.
 
 ## Documentation
 
-- [CLI](https://synpath.dev/docs/quickstart): hosted data API sign-in and keys versus local venue trading server setup
-- [Unified API](https://synpath.dev/docs/sdks/python): methods, data structures, identifiers, paging, status, errors
-- [Capabilities](https://synpath.dev/docs/concepts/exchanges): what each venue can and cannot answer
-- [HTTP server](https://synpath.dev/docs/api-reference): routes, envelopes, typed client generation, trading routes with per-account keys, mounting behind your own auth
-- [Trading](https://synpath.dev/docs/concepts/orders): credentials, `Decimal` money, order entry on Kalshi, Polymarket and Polymarket US
-- [Streaming](https://synpath.dev/docs/ws-api-reference): WebSocket and gRPC books, trades, orders and fills as self-healing event streams
-- [Engine](docs/engine.md): a journal written before anything is sent, pre-trade risk, a ledger, reconciliation, a kill switch, the order types the venues do not hold, buckets that route one order across venues, paper trading
-- [TypeScript client](https://synpath.dev/docs/sdks/typescript): generate a typed client from the OpenAPI document, place through cancel without Python
+See the [API Reference](https://www.synpath.dev/docs) for detailed documentation and more examples.
 
 ## Development
 
 ```bash
 git clone https://github.com/Synpath-ai/synpath
 cd synpath
-pip install -e ".[dev]"
+pip install -e ".[dev]"   # builds the Rust core too: needs a Rust toolchain (rustup.rs)
 
 pytest              # offline, against recorded venue payloads
 pytest -m live      # market data against the real venues
 pytest -m demo      # order entry on a venue's demo environment
+SYNPATH_PURE_PYTHON=1 pytest   # the same tests on the pure-Python fallback
+cargo test -p synpath-core     # the Rust core on its own
 ```
 
+The Rust core lives in `crates/synpath-core` (pure Rust) and
+`bindings/python` (its PyO3 wrapper, built as `synpath._core`). Every class
+it provides has a pure-Python twin with the same interface, and the library
+uses the twin when the extension is not built. Venue adapters are plain
+Python: adding a venue needs no Rust.
+
 The `demo` tests place and cancel real orders on a demo exchange with the
 credentials in your environment, and leave the account flat. `python -m
 synpath.trading doctor` says which venues are configured without printing a
@@ -167,7 +179,7 @@ secret.
 
 ## Prior Art
 
-[ccxt](https://github.com/ccxt/ccxt) set the conventions this library follows. [pmxt](https://github.com/pmxt-dev/pmxt) got to prediction markets first.
+[ccxt](https://github.com/ccxt/ccxt) set the conventions this library follows.
 
 ## License