redblack-python-sdk 0.1.0__py3-none-any.whl

redblack_python_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: redblack-python-sdk
+Version: 0.1.0
+Summary: Typed Python SDK for the RedBlack trading and portfolio rebalancing API
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.6
+Requires-Dist: python-dotenv<2,>=1.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: PyYAML<7,>=6; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=5; extra == "dev"
+Requires-Dist: pyright>=1.1; extra == "dev"
+Requires-Dist: ruff>=0.3; extra == "dev"
+
+# RedBlack Python SDK
+
+Typed Python client for the RedBlack trading, portfolio-rebalancing, and
+order-management API.
+
+> **Alpha:** the SDK is implemented from the offline RedBlack `2026.3.0`
+> contract. Live UAT validation has not yet been run. See
+> [`docs/UAT_VALIDATION.md`](docs/UAT_VALIDATION.md).
+
+## Requirements
+
+- Python 3.11 or newer
+- A RedBlack environment, API key, application client ID, and either:
+  - a RedBlack API username, password, and client secret; or
+  - an externally managed access token
+
+## Install for development
+
+```sh
+python3 -m pip install -e '.[dev]'
+```
+
+## Quick start
+
+```python
+from redblack import Environment, PasswordCredentials, RedBlackClient
+
+credentials = PasswordCredentials(
+    client_secret="read-from-a-secret-store",
+    username="read-from-a-secret-store",
+    password="read-from-a-secret-store",
+)
+
+with RedBlackClient(
+    environment=Environment.UAT,
+    api_version="2026.3.0",
+    api_key="read-from-a-secret-store",
+    client_id="read-from-a-secret-store",
+    credentials=credentials,
+) as client:
+    page = client.accounts.list(top=100, order_by="id asc")
+    for account in page.items:
+        print(account)
+```
+
+The normal constructor never reads environment variables or files. Applications
+that intentionally want configuration lookup can use
+`RedBlackClient.from_env()` or `RedBlackClient.from_dotenv()`.
+
+## Safety defaults
+
+- UAT or production must be selected explicitly.
+- TLS verification is on and ambient proxy/CA variables are ignored by default.
+- Access tokens are cached in memory and concurrent refresh is single-flight.
+- Automatic retries apply to safe reads only.
+- `POST`, `PATCH`, and `DELETE` are never replayed automatically.
+- Task updates/deletes require the exact ETag returned by task retrieval.
+- Deleting all cash actions requires a separate explicit confirmation.
+- Export storage downloads never receive RedBlack credentials.
+- Unknown response fields and enum values are preserved.
+
+## API shape
+
+Endpoints are grouped under:
+
+```text
+client.accounts
+client.households
+client.restrictions
+client.equivalents
+client.cash_actions
+client.securities
+client.orders
+client.review_sets
+client.users
+client.tasks
+```
+
+Collection methods support RedBlack's OData options through Python arguments:
+`filter`, `order_by`, `top`, `skip`, and `count`.
+
+List Trade Blotter or Trade Reconciliation orders with the new Orders resource:
+
+```python
+from redblack.models import OrderFilterType
+
+page = client.orders.list(top=100, count=True)  # Active Trade Blotter orders
+for order in client.orders.iter_all(
+    filter_type=OrderFilterType.IN_RECONCILIATION,
+    order_by="id asc",
+    max_items=1_000,
+):
+    print(order.id, order.quantity)
+```
+
+The SDK now defaults to `Accept-Version: 2026.3.0`; older API versions are not
+supported by typed methods. Orders in review sets remain accessible through
+`client.review_sets.list_pending_orders()`.
+
+Friendly request and response types such as `Account`, `Task`, `TaskUpdate`,
+and `CashActionCreate` are exported from `redblack.models`. Dictionary inputs
+are also validated before an HTTP request is sent.
+
+## Development commands
+
+```sh
+ruff format --check .
+ruff check .
+pyright
+pytest
+python3 tools/generate_sdk_models.py --check
+python3 api-docs/tools/build_openapi_docs.py --check
+python3 tools/check_operation_coverage.py
+python3 -m build --no-isolation
+```
+
+The normal test suite uses mock transports and must not call RedBlack.
+
+## Documentation
+
+- [`docs/REDBLACK_PRIMER.md`](docs/REDBLACK_PRIMER.md) — start here if you are
+  new to RedBlack, rebalancing, or trading workflows
+- [`docs/USAGE.md`](docs/USAGE.md)
+- [`docs/API_COVERAGE.md`](docs/API_COVERAGE.md)
+- [`docs/COMPATIBILITY.md`](docs/COMPATIBILITY.md)
+- [`docs/UAT_VALIDATION.md`](docs/UAT_VALIDATION.md)

redblack_python_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,38 @@
+redblack/__init__.py,sha256=iiD8qywLtfyhR0EXaUNh4JJmW_23FW8m5YwiZlk7jyw,2489
+redblack/_version.py,sha256=1EKzEgmC4ZJduEmo4qy_RWt7QfGVRqIGMe5MK_13O0Q,104
+redblack/auth.py,sha256=WkhTomLM0wA3fjN8JvRBIrAym3fjDPZdxv0mafscjDI,12418
+redblack/client.py,sha256=oKaHLzxGsynl18C4cw-dI-DNwJN4NAWC-VDwj9ODmqg,17629
+redblack/config.py,sha256=YhdoUmcx_dHnJb22D2O0jndDq_B1U4nyKv051ORvi8U,21358
+redblack/downloads.py,sha256=aMhRabkEK-731NjSOXlAap5OEUVIKQTFdTw5urY6bHA,14770
+redblack/errors.py,sha256=L4nB-ckbmy7MPj14Du5YWQLPfhvDhDge_lIYuyt94KY,14389
+redblack/odata.py,sha256=2mVGtIQyyrLVPlGXHGeHUnntoDHB5fJJa1Tq3zjkfto,2698
+redblack/pagination.py,sha256=h66JUy5C90w5ixdT4Qa_5EGDGk-W6n75XHu6LTi86W8,5795
+redblack/polling.py,sha256=Q3IES7lNPTyMxw4bkl72F_QoGANdFUmpvOEKjbz7R_g,5996
+redblack/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+redblack/raw.py,sha256=esUmIHPIc8EXXqF4Jzzpw8IMrh4qW_cIt5K7PizOk-U,3227
+redblack/response.py,sha256=qDVJ6GkxoZ1FP0ITEIQnT5HyGG-DkYBf-M0lTm_-iq4,3580
+redblack/transport.py,sha256=4Y1EzPNRuxv9zy-HcrAVEdf1fMKykyC9nSD-QlCr7uw,22700
+redblack/_generated/__init__.py,sha256=oHV6B1s3O5YdD4PN2xZRELptwIVoMpuCgszb5wdVZwk,758
+redblack/_generated/contract.py,sha256=y6l96kXyC8oKz4AyrglYCr1pf5OjMhwvhjlaZwFZc7g,7193
+redblack/_generated/operation_specs.py,sha256=erWog2mbveV9PS6DSshSInSkz_6mK0RGoNQftd9Ixz4,213988
+redblack/models/__init__.py,sha256=_bjll5YuPnVz35b3jFWzVvHd5jWkXdWJuKR1QaolcBI,3640
+redblack/models/base.py,sha256=a988a0iqpmuQTODW27_1Ss32jOsodPSiQ8bV5-1U5Bo,4418
+redblack/models/generated.py,sha256=Mp-rpgyCB3s_tstZztSuKAMWE9kC4IDYFoVdHzrR18I,984337
+redblack/resources/__init__.py,sha256=9AFskG3GYw5RfpCUV5H4QK8hBjmyhevip45sDQKrQlk,1845
+redblack/resources/_base.py,sha256=R2wksihXk_n93pwPuE4cxNNfBgIzr3SzrWHuQhtjt_k,7076
+redblack/resources/_collections.py,sha256=hyHZXQn68ZDQoERjS1ScaxA0KKjuTwiD6foxIl7GLhM,2653
+redblack/resources/_exports.py,sha256=dM0UsQHais13qQlDoNnsyCLEFn__T9hEl_ONYl01cag,7116
+redblack/resources/accounts.py,sha256=aMz2VuAtzLNTNv2IcS-k59LFFJ0CVO-MMynEGuK80lo,4040
+redblack/resources/cash_actions.py,sha256=aqMQBQDWHiPk6JrVc9_7XtdnyUj5crB9LnRRw8QUX30,8537
+redblack/resources/equivalents.py,sha256=snq-4cFjtxAigg-87VGpeMGJKK1sGk20ddqFQAu5KMg,4397
+redblack/resources/households.py,sha256=oPguVV2apBeUJ_pr_nv4Cdy2myyZsCXbi5aEM_j05lg,4150
+redblack/resources/orders.py,sha256=ZuaykmmCAx78kEqNHnhRJPUpoHn_2EdNUeWfylwCVpQ,3724
+redblack/resources/restrictions.py,sha256=c-_9XbfnSx3ra6-87r0TDCGoso1DDXV70oFCnQQGra4,4532
+redblack/resources/review_sets.py,sha256=07DXWVJ3YI8WImoH-xX3rrNMOJiyL8u9OEEZUjkt5F0,30628
+redblack/resources/securities.py,sha256=tvFql4JZ50XAg4n1ru8OOf4WQyxQ0oQSo9PZI9shp8o,4976
+redblack/resources/tasks.py,sha256=EAWfm0reO5DgcY8QCdHS2sTzrdIpYh9VGyPB9ugyC5g,8336
+redblack/resources/users.py,sha256=ELqQNb3af-AcarXqcwFDpaiuiInR2mPsPj_VYNc9VN0,2471
+redblack_python_sdk-0.1.0.dist-info/METADATA,sha256=mYcM0B05sSjdZAngxtfTDbN9xmF2EZfLRva7AygXCW8,4756
+redblack_python_sdk-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+redblack_python_sdk-0.1.0.dist-info/top_level.txt,sha256=h7EJCCLQPAM0UKlnQDOYeR_YeNAenEE_0LEzeIgDc7o,9
+redblack_python_sdk-0.1.0.dist-info/RECORD,,

redblack_python_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

redblack_python_sdk-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+redblack