architect-py 5.1.2__tar.gz → 5.1.3__tar.gz

{architect_py-5.1.2 → architect_py-5.1.3}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: architect-py
-Version: 5.1.2
+Version: 5.1.3
 Summary: Python SDK for the Architect trading platform and brokerage.
 Author-email: "Architect Financial Technologies, Inc." <hello@architect.co>
 License-Expression: Apache-2.0
-Project-URL: Homepage, https://www.architect.co/brokerage/overview
 Project-URL: Documentation, https://docs.architect.co
+Project-URL: Homepage, https://www.architect.co/brokerage/overview
 Project-URL: Repository, https://github.com/architect-xyz/architect-py
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
@@ -48,7 +48,7 @@ Go to [FUNCTIONS.md](FUNCTIONS.md) file to see a catalog of methods.
 
 ## Examples
 
-Go to the [Examples](./examples) to see examples of a variety of common use cases.
+Go to the [Examples](./examples) to see examples of a variety of common use cases.  To run a specific example, use e.g. `python -m examples.orderflow_streaming`.
 
 ## Documentation 
 

{architect_py-5.1.2 → architect_py-5.1.3}/README.md

@@ -23,7 +23,7 @@ Go to [FUNCTIONS.md](FUNCTIONS.md) file to see a catalog of methods.
 
 ## Examples
 
-Go to the [Examples](./examples) to see examples of a variety of common use cases.
+Go to the [Examples](./examples) to see examples of a variety of common use cases.  To run a specific example, use e.g. `python -m examples.orderflow_streaming`.
 
 ## Documentation 
 

{architect_py-5.1.2 → architect_py-5.1.3}/architect_py/__init__.py

@@ -1,6 +1,6 @@
 # ruff: noqa:I001
 
-__version__ = "5.1.2"
+__version__ = "5.1.3"
 
 from .utils.nearest_tick import TickRoundMethod
 from .async_client import AsyncClient

{architect_py-5.1.2 → architect_py-5.1.3}/architect_py/async_client.py

@@ -364,6 +364,15 @@ class AsyncClient:
             "as of v5.0.0: enable_orderflow is deprecated; orderflow is enabled by default"
         )
 
+    async def cpty_status(self, kind: str, instance: Optional[str] = None) -> CptyStatus:
+        """
+        Get cpty status.
+        """
+        grpc_client = await self.core()
+        req = CptyStatusRequest(kind=kind, instance=instance)
+        res: CptyStatus = await grpc_client.unary_unary(req)
+        return res
+
     # ------------------------------------------------------------
     # Symbology
     # ------------------------------------------------------------
@@ -1382,28 +1391,16 @@ class AsyncClient:
 
         Example:
             ```python
-            async for of in client.stream_orderflow(account, execution_venue, trader):
-                print(of)
+            async for event in client.stream_orderflow(account, execution_venue, trader):
+                print(event)
             ```
         """
         grpc_client = await self.core()
-        request: SubscribeOrderflowRequest = SubscribeOrderflowRequest(
+        req: SubscribeOrderflowRequest = SubscribeOrderflowRequest(
             account=account, execution_venue=execution_venue, trader=trader
         )
-        grpc_client = await self.core()
-        decoder = grpc_client.get_decoder(SubscribeOrderflowRequest)
-        stub: grpc.aio.UnaryStreamMultiCallable[
-            SubscribeOrderflowRequest, Orderflow
-        ] = grpc_client.channel.unary_stream(
-            SubscribeOrderflowRequest.get_route(),
-            request_serializer=grpc_client.encoder().encode,
-            response_deserializer=decoder.decode,
-        )
-        call: grpc.aio._base_call.UnaryStreamCall[
-            SubscribeOrderflowRequest, Orderflow
-        ] = stub(request, metadata=(("authorization", f"Bearer {grpc_client.jwt}"),))
-        async for update in call:
-            yield update
+        async for res in grpc_client.unary_stream(req):  # type: ignore
+            yield res
 
     # ------------------------------------------------------------
     # Order entry

{architect_py-5.1.2 → architect_py-5.1.3}/architect_py/grpc/models/Marketdata/SubscribeL1BookSnapshotsRequest.py

@@ -10,6 +10,17 @@ from msgspec import Meta, Struct
 
 
 class SubscribeL1BookSnapshotsRequest(Struct, omit_defaults=True):
+    send_initial_snapshots: Optional[
+        Annotated[
+            bool,
+            Meta(
+                description="If true, send an initial snapshot to subscribers on symbol subscription"
+            ),
+        ]
+    ] = False
+    """
+    If true, send an initial snapshot to subscribers on symbol subscription
+    """
     symbols: Optional[
         Annotated[
             List[str],
@@ -25,16 +36,18 @@ class SubscribeL1BookSnapshotsRequest(Struct, omit_defaults=True):
     @classmethod
     def new(
         cls,
+        send_initial_snapshots: Optional[bool] = False,
         symbols: Optional[List[str]] = None,
         venue: Optional[str] = None,
     ):
         return cls(
+            send_initial_snapshots,
             symbols,
             venue,
         )
 
     def __str__(self) -> str:
-        return f"SubscribeL1BookSnapshotsRequest(symbols={self.symbols},venue={self.venue})"
+        return f"SubscribeL1BookSnapshotsRequest(send_initial_snapshots={self.send_initial_snapshots},symbols={self.symbols},venue={self.venue})"
 
     @staticmethod
     def get_response_type():

{architect_py-5.1.2 → architect_py-5.1.3}/architect_py.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: architect-py
-Version: 5.1.2
+Version: 5.1.3
 Summary: Python SDK for the Architect trading platform and brokerage.
 Author-email: "Architect Financial Technologies, Inc." <hello@architect.co>
 License-Expression: Apache-2.0
-Project-URL: Homepage, https://www.architect.co/brokerage/overview
 Project-URL: Documentation, https://docs.architect.co
+Project-URL: Homepage, https://www.architect.co/brokerage/overview
 Project-URL: Repository, https://github.com/architect-xyz/architect-py
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
@@ -48,7 +48,7 @@ Go to [FUNCTIONS.md](FUNCTIONS.md) file to see a catalog of methods.
 
 ## Examples
 
-Go to the [Examples](./examples) to see examples of a variety of common use cases.
+Go to the [Examples](./examples) to see examples of a variety of common use cases.  To run a specific example, use e.g. `python -m examples.orderflow_streaming`.
 
 ## Documentation 
 

{architect_py-5.1.2 → architect_py-5.1.3}/architect_py.egg-info/SOURCES.txt

@@ -181,12 +181,15 @@ architect_py/utils/symbol_parsing.py
 examples/__init__.py
 examples/book_subscription.py
 examples/candles.py
-examples/common.py
+examples/config.py
 examples/external_cpty.py
 examples/funding_rate_mean_reversion_algo.py
 examples/order_sending.py
+examples/orderflow_channel.py
+examples/orderflow_streaming.py
 examples/stream_l1_marketdata.py
 examples/stream_l2_marketdata.py
+examples/termutils.py
 examples/trades.py
 examples/tutorial_async.py
 examples/tutorial_sync.py

{architect_py-5.1.2 → architect_py-5.1.3}/architect_py.egg-info/top_level.txt

@@ -1,6 +1,6 @@
 architect_py
 dist
 examples
-ipynb
+htmlcov
 scripts
 templates

{architect_py-5.1.2 → architect_py-5.1.3}/examples/book_subscription.py

@@ -6,7 +6,7 @@ from pydantic import ValidationError
 from architect_py import AsyncClient, TradableProduct
 from architect_py.graphql_client.exceptions import GraphQLClientHttpError
 
-from .common import connect_async_client
+from .config import connect_async_client
 
 buy_columns = "{:>15} {:>15} {:>15}"
 sell_columns = "{:<15} {:<15} {:<15}"

{architect_py-5.1.2 → architect_py-5.1.3}/examples/candles.py

@@ -3,7 +3,7 @@ import asyncio
 from architect_py import AsyncClient, CandleWidth, TradableProduct
 from architect_py.graphql_client.exceptions import GraphQLClientHttpError
 
-from .common import connect_async_client
+from .config import connect_async_client
 
 
 async def main():

architect_py-5.1.2/examples/common.py → architect_py-5.1.3/examples/config.py

@@ -16,15 +16,17 @@ class Config:
 
 def load_config() -> Config:
     loaded = load_dotenv()
+
     if not loaded:
         raise ValueError(
-            "⚠️  .env file not found or had no new variables\n"
-            "Please create a .env file with the following variables:\n"
+            "⚠️  .env file not found or had no new variables\n\n"
+            "Please create a .env file with the following variables:\n\n"
             "ARCHITECT_ENDPOINT=your_endpoint (e.g. app.architect.co)\n"
             "ARCHITECT_API_KEY=your_api_key (get from https://app.architect.co/user/account)\n"
             "ARCHITECT_API_SECRET=your_api_secret\n"
             "ARCHITECT_PAPER_TRADING=true/false\n"
         )
+
     endpoint = os.environ["ARCHITECT_ENDPOINT"]
     api_key = os.getenv("ARCHITECT_API_KEY")
     api_secret = os.getenv("ARCHITECT_API_SECRET")
@@ -49,7 +51,6 @@ def load_config() -> Config:
 
 def connect_client():
     config = load_config()
-
     c = Client(
         endpoint=config.endpoint,
         api_key=config.api_key,
@@ -68,48 +69,3 @@ async def connect_async_client():
         paper_trading=config.paper_trading,
     )
     return c
-
-
-buy_columns = "{:>15} {:>15} {:>15}"
-sell_columns = "{:<15} {:<15} {:<15}"
-green = "\033[32m"
-red = "\033[31m"
-normal = "\033[0m"
-
-
-def print_book(book):
-    print(
-        (buy_columns + " " + sell_columns).format(
-            "Total", "Size", "Bid", "Ask", "Size", "Total"
-        )
-    )
-    for i in range(min(20, len(book.bids), len(book.asks))):
-        b = book.bids[i]
-        s = book.asks[i]
-        print(
-            (green + buy_columns).format(b.total, b.amount, b.price),
-            (red + sell_columns).format(s.price, s.amount, s.total),
-        )
-    print(normal)
-
-
-def print_open_orders(orders):
-    if len(orders) == 0:
-        print("No open orders")
-    else:
-        for o in orders:
-            print(
-                f"  • {o.order.market.name} {o.order.dir} {o.order.quantity} {o.order.order_type.limit_price}"
-            )
-
-
-def confirm(prompt: str):
-    """
-    Ask user to enter Y or N (case-insensitive).
-    :return: True if the answer is Y.
-    :rtype: bool
-    """
-    answer = ""
-    while answer not in ["y", "n"]:
-        answer = input(f"{prompt} [Y/N]? ").lower()
-    return answer == "y"

{architect_py-5.1.2 → architect_py-5.1.3}/examples/funding_rate_mean_reversion_algo.py

@@ -24,7 +24,7 @@ from architect_py.grpc.models.Orderflow.OrderflowRequest import (
     PlaceOrder,
 )
 
-from .common import connect_async_client
+from .config import connect_async_client
 
 venue = "BINANCE"
 product = "BTC-USDT Perpetual"

{architect_py-5.1.2 → architect_py-5.1.3}/examples/order_sending.py

@@ -4,7 +4,7 @@ from datetime import datetime, timedelta, timezone
 from decimal import Decimal
 
 from architect_py import AsyncClient, OrderDir, OrderType, TimeInForce, TradableProduct
-from examples.common import connect_async_client
+from examples.config import connect_async_client
 
 LOGGER = logging.getLogger(__name__)
 

architect_py-5.1.3/examples/orderflow_channel.py

@@ -0,0 +1,56 @@
+# """
+# Example of using a bidirectional orderflow channel with the Architect OEMS.
+
+# This connection style is ~equivalent to having a websocket.
+
+# This code example sends a series of orders to Architect while concurrently
+# listening to orderflow events.  Compare to `examples/orderflow_streaming.py`,
+# which accomplishes the same thing but using a separate asyncio task.
+# """
+
+# import asyncio
+# from decimal import Decimal
+
+# from architect_py import AsyncClient, OrderDir, PlaceOrderRequest
+# from architect_py.grpc.models.Orderflow.OrderflowRequest import PlaceOrder
+
+# from .config import connect_async_client
+
+
+# async def send_orders(client: AsyncClient):
+#     symbol = await client.get_front_future("ES CME Futures")
+#     print(f"symbol={symbol}")
+
+#     while True:
+#         await asyncio.sleep(1)
+#         snap = await client.get_l1_book_snapshot(symbol, "CME")
+#         if snap.best_ask is not None:
+#             limit_price = snap.best_ask[0]
+#             print(f"\nPlacing buy order at {limit_price}\n")
+#             try:
+#                 req = PlaceOrderRequest.new(
+#                     symbol=symbol,
+#                     execution_venue="CME",
+#                     dir=OrderDir.BUY,
+#                     quantity=Decimal(1),
+#                     limit_price=limit_price,
+#                     post_only=True,
+#                     time_in_force="DAY",
+#                     order_type="LIMIT",
+#                 )
+#                 print(f"req={req}")
+#                 yield PlaceOrder(req)
+#             except Exception as e:
+#                 print(f"Error placing order: {e}")
+#         else:
+#             print("\nNo ask price from snapshot, doing nothing\n")
+
+
+# async def main():
+#     client = await connect_async_client()
+
+#     async for event in client.orderflow(send_orders(client)):
+#         print(f" --> {event}")
+
+
+# asyncio.run(main())

architect_py-5.1.3/examples/orderflow_streaming.py

@@ -0,0 +1,47 @@
+"""
+Example of streaming orderflow events from the Architect OEMS.
+
+This code example sends a series of orders to Architect in one asyncio
+task, while concurrently listening to orderflow events in another.
+"""
+
+import asyncio
+from decimal import Decimal
+
+from architect_py import AsyncClient, OrderDir
+
+from .config import connect_async_client
+
+
+async def send_orders(client: AsyncClient):
+    symbol = await client.get_front_future("ES CME Futures")
+    print(f"symbol={symbol}")
+
+    while True:
+        await asyncio.sleep(1)
+        snap = await client.get_l1_book_snapshot(symbol, "CME")
+        if snap.best_ask is not None:
+            limit_price = snap.best_ask[0]
+            print(f"\nPlacing buy order at {limit_price}\n")
+            await client.place_limit_order(
+                symbol=symbol,
+                execution_venue="CME",
+                dir=OrderDir.BUY,
+                quantity=Decimal(1),
+                limit_price=limit_price,
+                post_only=True,
+            )
+        else:
+            print("\nNo ask price from snapshot, doing nothing\n")
+
+
+async def main():
+    client = await connect_async_client()
+
+    asyncio.create_task(send_orders(client))
+
+    async for event in client.stream_orderflow():
+        print(f" --> {event}")
+
+
+asyncio.run(main())

{architect_py-5.1.2 → architect_py-5.1.3}/examples/stream_l1_marketdata.py

@@ -2,7 +2,7 @@ import asyncio
 
 from architect_py import AsyncClient, TradableProduct
 
-from .common import connect_async_client
+from .config import connect_async_client
 
 
 async def main():

{architect_py-5.1.2 → architect_py-5.1.3}/examples/stream_l2_marketdata.py

@@ -2,7 +2,7 @@ import asyncio
 
 from architect_py import AsyncClient, TradableProduct
 
-from .common import connect_async_client
+from .config import connect_async_client
 
 buy_columns = "{:>15} {:>15}"
 sell_columns = "{:<15} {:<15}"

architect_py-5.1.3/examples/termutils.py

@@ -0,0 +1,44 @@
+buy_columns = "{:>15} {:>15} {:>15}"
+sell_columns = "{:<15} {:<15} {:<15}"
+green = "\033[32m"
+red = "\033[31m"
+normal = "\033[0m"
+
+
+def print_book(book):
+    print(
+        (buy_columns + " " + sell_columns).format(
+            "Total", "Size", "Bid", "Ask", "Size", "Total"
+        )
+    )
+    for i in range(min(20, len(book.bids), len(book.asks))):
+        b = book.bids[i]
+        s = book.asks[i]
+        print(
+            (green + buy_columns).format(b.total, b.amount, b.price),
+            (red + sell_columns).format(s.price, s.amount, s.total),
+        )
+    print(normal)
+
+
+def print_open_orders(orders):
+    if len(orders) == 0:
+        print("No open orders")
+    else:
+        for o in orders:
+            print(
+                f"  • {o.order.market.name} {o.order.dir} {o.order.quantity} {o.order.order_type.limit_price}"
+            )
+
+
+def confirm(prompt: str):
+    """
+    Ask user to enter Y or N (case-insensitive).
+
+    :return: True if the answer is Y.
+    :rtype: bool
+    """
+    answer = ""
+    while answer not in ["y", "n"]:
+        answer = input(f"{prompt} [Y/N]? ").lower()
+    return answer == "y"

{architect_py-5.1.2 → architect_py-5.1.3}/examples/trades.py

@@ -3,7 +3,7 @@ import asyncio
 from architect_py import AsyncClient, TradableProduct
 from architect_py.graphql_client.exceptions import GraphQLClientHttpError
 
-from .common import connect_async_client
+from .config import connect_async_client
 
 
 async def main():

{architect_py-5.1.2 → architect_py-5.1.3}/examples/tutorial_async.py

@@ -2,7 +2,8 @@ import asyncio
 from decimal import Decimal
 
 from architect_py import OrderDir, OrderStatus, TradableProduct
-from examples.common import connect_async_client
+
+from .config import connect_async_client
 
 
 async def main():

{architect_py-5.1.2 → architect_py-5.1.3}/examples/tutorial_sync.py

@@ -5,7 +5,8 @@ from decimal import Decimal
 from architect_py import OrderDir, OrderStatus
 from architect_py.utils.nearest_tick import TickRoundMethod
 
-from .common import confirm, connect_client, print_book, print_open_orders
+from .config import connect_client
+from .termutils import confirm, print_book, print_open_orders
 
 c = connect_client()
 

{architect_py-5.1.2 → architect_py-5.1.3}/pyproject.toml

@@ -22,7 +22,7 @@ license = "Apache-2.0"
 name = "architect-py"
 readme = "README.md"
 requires-python = ">=3.10,<4"
-version = "5.1.2"
+version = "5.1.3"
 
 [dependency-groups]
 dev = [
@@ -65,6 +65,6 @@ select = ["E4", "E7", "E9", "F", "I"]
 
 
 [project.urls]
-Homepage = "https://www.architect.co/brokerage/overview"
 Documentation = "https://docs.architect.co"
-Repository = "https://github.com/architect-xyz/architect-py"
+Homepage = "https://www.architect.co/brokerage/overview"
+Repository = "https://github.com/architect-xyz/architect-py"