mftik 0.0.3__tar.gz

mftik-0.0.3/.gitignore

@@ -0,0 +1,41 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+.venv/
+venv/
+.env
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Node / SvelteKit
+node_modules/
+frontend/.svelte-kit/
+frontend/build/
+frontend/.vite/
+frontend/package-lock.json
+
+# IDE / OS
+.idea/
+.vscode/
+*.swp
+.DS_Store
+*.log
+
+# Docker
+*.pid
+
+# Live API tokens (Hostinger, GitHub, Discord). Never commit.
+credentials/
+
+# Local node data (strategy registry). Default when MFTIK_DATA is unset.
+.mftik/
+mft/

mftik-0.0.3/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.5
+Name: mftik
+Version: 0.0.3
+Summary: MFTIK — strategy SDK and client for a self-hosted trading node
+Project-URL: Homepage, https://github.com/lynxlinkage/mftik
+Project-URL: Source, https://github.com/lynxlinkage/mftik
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.12
+Requires-Dist: cryptography>=42.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: redis>=5.0
+Requires-Dist: websockets>=14.0
+Description-Content-Type: text/markdown
+
+# mftik
+
+The strategy SDK and command-line client for a [MFTIK](https://github.com/lynxlinkage/mftik)
+node — a self-hosted, mid-frequency algorithmic trading platform.
+
+You run the node yourself with Docker Compose — `mftik node-init` writes the
+stack for you. This package is both that and what you install on the machine
+you write strategies on.
+
+```bash
+pip install mftik
+```
+
+## Writing a strategy
+
+A strategy is a subclass of `Strategy` and a directory of `.py` files. It reads
+market data through the hooks it overrides and trades through the accessors the
+base class binds.
+
+```python
+from mftik.strategy import Strategy
+
+
+class MyStrategy(Strategy):
+    name = "my_strategy"
+
+    async def on_best_quote(self, quote) -> None:
+        await self.log(f"{quote.universal_ticker} {quote.bid}/{quote.ask}")
+```
+
+`self.oms` places and cancels orders, `self.ledger` reads balances, `self.mds`
+queries history the feeds do not carry, `self.tape` warms up on prints from
+before the session started, `self.symbols` gives you the tick and step sizes to
+round to, and `self.timer` schedules work. See `Strategy`'s docstring for the
+full set of hooks.
+
+A strategy may import the standard library, `mftik`, and other files in its own
+directory — nothing else. The node runs the source you send it rather than an
+environment you built, so a third-party import would be a module that is not
+there. `mftik check` tells you before you push.
+
+## The client
+
+```bash
+mftik node-init ./mynode                 # a whole node: compose, edge, .env
+mftik connect https://node.example.com   # sign in once; stores an API key
+mftik whoami                             # who you are to that node
+mftik profiles                           # every node this machine knows
+mftik disconnect <name>                  # forget one
+mftik init ./hello                       # scaffold, filled in from that node
+mftik check ./hello                      # import gate and on_initialized, offline
+mftik run ./hello                        # push, deploy, tail; ^C stops it
+mftik push ./hello                       # copy the tree into the node's private registry
+mftik run ./hello                        # push, deploy, tail the session log
+mftik ps                                 # what is running
+mftik logs -f <session>                  # what it is saying
+mftik stop <session>                     # stop it
+```
+
+`connect` signs in with your password, mints an API key through that session,
+stores the key and drops the session — so the password is never written down.
+Profiles live in `~/.config/mftik/config.toml` at mode `0600`. For CI, pass an
+existing key with `--token` and no prompt is reached.
+
+`init` is being built — see
+[docs/CLI.md](https://github.com/lynxlinkage/mftik/blob/main/docs/CLI.md) for the
+shape it is landing in.
+
+## License
+
+MIT

mftik-0.0.3/README.md

@@ -0,0 +1,71 @@
+# mftik
+
+The strategy SDK and command-line client for a [MFTIK](https://github.com/lynxlinkage/mftik)
+node — a self-hosted, mid-frequency algorithmic trading platform.
+
+You run the node yourself with Docker Compose — `mftik node-init` writes the
+stack for you. This package is both that and what you install on the machine
+you write strategies on.
+
+```bash
+pip install mftik
+```
+
+## Writing a strategy
+
+A strategy is a subclass of `Strategy` and a directory of `.py` files. It reads
+market data through the hooks it overrides and trades through the accessors the
+base class binds.
+
+```python
+from mftik.strategy import Strategy
+
+
+class MyStrategy(Strategy):
+    name = "my_strategy"
+
+    async def on_best_quote(self, quote) -> None:
+        await self.log(f"{quote.universal_ticker} {quote.bid}/{quote.ask}")
+```
+
+`self.oms` places and cancels orders, `self.ledger` reads balances, `self.mds`
+queries history the feeds do not carry, `self.tape` warms up on prints from
+before the session started, `self.symbols` gives you the tick and step sizes to
+round to, and `self.timer` schedules work. See `Strategy`'s docstring for the
+full set of hooks.
+
+A strategy may import the standard library, `mftik`, and other files in its own
+directory — nothing else. The node runs the source you send it rather than an
+environment you built, so a third-party import would be a module that is not
+there. `mftik check` tells you before you push.
+
+## The client
+
+```bash
+mftik node-init ./mynode                 # a whole node: compose, edge, .env
+mftik connect https://node.example.com   # sign in once; stores an API key
+mftik whoami                             # who you are to that node
+mftik profiles                           # every node this machine knows
+mftik disconnect <name>                  # forget one
+mftik init ./hello                       # scaffold, filled in from that node
+mftik check ./hello                      # import gate and on_initialized, offline
+mftik run ./hello                        # push, deploy, tail; ^C stops it
+mftik push ./hello                       # copy the tree into the node's private registry
+mftik run ./hello                        # push, deploy, tail the session log
+mftik ps                                 # what is running
+mftik logs -f <session>                  # what it is saying
+mftik stop <session>                     # stop it
+```
+
+`connect` signs in with your password, mints an API key through that session,
+stores the key and drops the session — so the password is never written down.
+Profiles live in `~/.config/mftik/config.toml` at mode `0600`. For CI, pass an
+existing key with `--token` and no prompt is reached.
+
+`init` is being built — see
+[docs/CLI.md](https://github.com/lynxlinkage/mftik/blob/main/docs/CLI.md) for the
+shape it is landing in.
+
+## License
+
+MIT

mftik-0.0.3/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+# The distribution a strategy author installs, and the one every service in
+# this workspace already shares. It was `mftik-common`, which named its role
+# in the monorepo rather than what it is off one: `pip install mftik` gets
+# you `import mftik` and the `mftik` command, and nothing about "common"
+# survives being read from outside this repository.
+name = "mftik"
+version = "0.0.3"
+description = "MFTIK — strategy SDK and client for a self-hosted trading node"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.0",
+    "redis>=5.0",
+    "pyyaml>=6.0",
+    "httpx>=0.27",
+    "websockets>=14.0",
+    # Ed25519, for Binance's WebSocket API session logon. Gate signs with
+    # HMAC out of hashlib; Binance accepts nothing but Ed25519 there.
+    "cryptography>=42.0",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Office/Business :: Financial :: Investment",
+]
+
+[project.urls]
+Homepage = "https://github.com/lynxlinkage/mftik"
+Source = "https://github.com/lynxlinkage/mftik"
+
+# The CLI is argparse and httpx, both of which are here already. A dependency
+# added for it would land in every service image too — they all install this
+# package — so the client stays built out of what the library already needs.
+[project.scripts]
+mftik = "mftik.cli:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/mftik"]
+# The compose stack `mftik node init` writes. Data, not code, so it has
+# to be named or the wheel ships a command that cannot do anything.
+artifacts = ["src/mftik/cli/templates/*"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src/mftik" = "mftik"

mftik-0.0.3/src/mftik/__init__.py

@@ -0,0 +1,10 @@
+"""Shared MFTIK library — protocol, broker, runtime, exchange, strategy.
+
+:mod:`mftik.strategy` is what a strategy is written against, and it is here
+rather than in the STS app so it installs beside a strategy on a developer's
+machine. Nothing in it needs a database or a running node.
+"""
+
+from mftik.runtime import configure_logging, run_heartbeat_service
+
+__all__ = ["configure_logging", "run_heartbeat_service"]

mftik-0.0.3/src/mftik/broker/__init__.py

@@ -0,0 +1,22 @@
+"""Async Redis broker — pub/sub, request-reply, and bidirectional streams."""
+
+from mftik.broker.client import Broker, BrokerClient
+from mftik.broker.config import BrokerConfig
+from mftik.broker.errors import (
+    BrokerError,
+    BrokerNotConnectedError,
+    RequestTimeoutError,
+)
+from mftik.broker.request import IncomingRequest
+from mftik.broker.stream import BidirectionalStream
+
+__all__ = [
+    "BidirectionalStream",
+    "Broker",
+    "BrokerClient",
+    "BrokerConfig",
+    "BrokerError",
+    "BrokerNotConnectedError",
+    "IncomingRequest",
+    "RequestTimeoutError",
+]