publicdotcom-cli 1.0.0__tar.gz

publicdotcom_cli-1.0.0/.gitattributes

@@ -0,0 +1 @@
+src/publicdotcom_cli/_generated/** linguist-generated=true

publicdotcom_cli-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+.venv/
+dist/
+build/
+*.egg-info/
+
+.pytest_cache/
+.ruff_cache/
+__pycache__/
+*.py[cod]
+
+.env
+.env.*
+spec.yaml

publicdotcom_cli-1.0.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: publicdotcom-cli
+Version: 1.0.0
+Summary: Command-line client for the Public.com Trading API
+Project-URL: Homepage, https://github.com/publicdotcom/publicdotcom-cli
+Project-URL: Repository, https://github.com/publicdotcom/publicdotcom-cli
+Project-URL: Issues, https://github.com/publicdotcom/publicdotcom-cli/issues
+Project-URL: Public.com API, https://public.com/api
+Author-email: "Public.com" <developers@public.com>
+Maintainer-email: "Public.com" <developers@public.com>
+License-Expression: Apache-2.0
+Keywords: api,brokerage,cli,crypto,options,public.com,stocks,trading
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: attrs>=23.2.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: keyring>=25.0.0
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: rich>=13.7.0
+Requires-Dist: typer>=0.16.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.11.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# publicdotcom-cli
+
+Command-line client for the Public.com Trading API.
+
+Use `public` to authenticate, inspect accounts, retrieve portfolio and market data, run
+preflight checks, and submit order-related requests from your terminal.
+
+## Install
+
+The recommended installation method for command-line Python tools is `pipx`:
+
+```bash
+pipx install publicdotcom-cli
+```
+
+You can also install with `uv`:
+
+```bash
+uv tool install publicdotcom-cli
+```
+
+Confirm the CLI is available:
+
+```bash
+public --help
+```
+
+## Quick Start
+
+Generate a personal secret from your Public.com settings, then authenticate:
+
+```bash
+public auth login
+public accounts list
+public accounts set-default ACCOUNT_ID
+public portfolio show
+public market quotes AAPL MSFT
+```
+
+Most account-scoped commands use the configured default account. You can override it with
+`--account-id ACCOUNT_ID` or `PUBLIC_ACCOUNT_ID=ACCOUNT_ID`.
+
+## Important Disclosures
+
+This CLI is a developer tool for interacting with the Public API. It is not investment,
+financial, legal, tax, accounting, or trading advice, and it does not recommend any
+security, strategy, account type, order type, or transaction.
+
+Trading involves risk, including the possible loss of principal. You are responsible for
+reviewing all request payloads, account IDs, symbols, quantities, prices, order sides,
+time-in-force values, and other order instructions before submitting a trading command.
+
+Order placement, replacement, and cancellation requests may be asynchronous. A successful
+API response confirms submission to the API, not execution, cancellation, fill price,
+availability, or final order state. Always verify order status after submitting,
+replacing, or cancelling an order.
+
+Market data, quotes, option chains, greeks, account data, and preflight calculations are
+provided for informational and operational use through the API. They may be incomplete,
+delayed, unavailable, or different from final execution values.
+
+You are responsible for complying with all applicable laws, regulations, exchange rules,
+API terms, account agreements, and internal policies that apply to your use of this CLI.
+Do not use this tool unless you are authorized to access the relevant account and API
+credentials.
+
+Personal secrets and access tokens can authorize account access and trading activity.
+Keep them private, do not commit them to source control, and rotate or revoke them if
+you believe they were exposed.
+
+## Authenticate
+
+Generate a personal secret from Public, then run:
+
+```bash
+public auth login
+```
+
+The access token is stored with your OS keychain when available. If no keychain backend
+is available, the CLI falls back to a user-only config file.
+
+Access tokens are short-lived. To let the CLI refresh them automatically, opt in to
+storing your personal secret:
+
+```bash
+public auth login --store-secret
+```
+
+Because the personal secret is long-lived, this is optional. The CLI stores it in your
+OS keychain when available, otherwise it falls back to a user-only config file.
+
+After that, secured commands automatically mint a fresh access token before the current
+token expires or after a `401 Unauthorized` response. You can also refresh manually:
+
+```bash
+public auth refresh
+```
+
+You can also bypass stored credentials for automation:
+
+```bash
+PUBLIC_ACCESS_TOKEN=ey... public accounts list
+PUBLIC_PERSONAL_SECRET=... public accounts list
+```
+
+Remove stored credentials with:
+
+```bash
+public auth logout
+public auth logout --all
+```
+
+## Default Account
+
+Most API operations require the `accountId` returned by `public accounts list`. You can
+store a default account once:
+
+```bash
+public accounts set-default ACCOUNT_ID
+public accounts get-default
+```
+
+Then omit `--account-id` from account-scoped commands:
+
+```bash
+public portfolio show
+public market quotes AAPL MSFT
+public order get ORDER_ID
+```
+
+You can override the default at any time:
+
+```bash
+public portfolio show --account-id ACCOUNT_ID
+PUBLIC_ACCOUNT_ID=ACCOUNT_ID public portfolio show
+public accounts clear-default
+```
+
+## Example Commands
+
+```bash
+public accounts list
+public accounts set-default ACCOUNT_ID
+public portfolio show
+public history list --page-size 25
+public instruments get AAPL EQUITY
+public market quotes AAPL MSFT --type EQUITY
+public market option-expirations AAPL
+public market option-chain AAPL 2026-05-15
+public options greeks "AAPL  260515C00200000"
+```
+
+Trading requests use JSON files so the exact payload is visible before submission:
+
+```bash
+public order preflight-single --file examples/order.single-leg.market-buy.json
+public order place --file examples/order.single-leg.market-buy.json
+public order get ORDER_ID
+public order cancel ORDER_ID
+```
+
+Trading commands prompt before submitting order placement, replacement, or cancellation
+requests. Use `--yes` only when your automation has already performed equivalent
+validation and approval.
+
+## JSON Output
+
+Use `--json` before the command group to print raw JSON:
+
+```bash
+public --json accounts list
+public --json market quotes AAPL MSFT
+```
+
+## Configuration
+
+The CLI supports these environment variables:
+
+```bash
+PUBLIC_ACCESS_TOKEN=...
+PUBLIC_PERSONAL_SECRET=...
+PUBLIC_ACCOUNT_ID=...
+PUBLIC_API_BASE_URL=https://api.public.com
+PUBLIC_AUTO_REFRESH=true
+```
+
+`PUBLIC_API_BASE_URL` is optional and defaults to `https://api.public.com`.
+
+## Upgrade
+
+```bash
+pipx upgrade publicdotcom-cli
+# or
+uv tool upgrade publicdotcom-cli
+```
+
+## Development
+
+For local development from a checkout:
+
+```bash
+uv sync --extra dev
+uv run public --help
+uv run pytest
+```
+
+## Regenerate The OpenAPI Client
+
+The package ships with a generated API client. Contributors who need to regenerate it
+must place the local OpenAPI spec at the repository root as `spec.yaml`, then run:
+
+```bash
+uv run python scripts/generate_client.py
+```
+
+The raw spec uses `*/*` for many JSON responses, which some Python generators do not
+parse as JSON. The regeneration script normalizes those response content types before
+running `openapi-python-client`. This requires network access the first time because it
+uses `uvx openapi-python-client`.

publicdotcom_cli-1.0.0/README.md

@@ -0,0 +1,219 @@
+# publicdotcom-cli
+
+Command-line client for the Public.com Trading API.
+
+Use `public` to authenticate, inspect accounts, retrieve portfolio and market data, run
+preflight checks, and submit order-related requests from your terminal.
+
+## Install
+
+The recommended installation method for command-line Python tools is `pipx`:
+
+```bash
+pipx install publicdotcom-cli
+```
+
+You can also install with `uv`:
+
+```bash
+uv tool install publicdotcom-cli
+```
+
+Confirm the CLI is available:
+
+```bash
+public --help
+```
+
+## Quick Start
+
+Generate a personal secret from your Public.com settings, then authenticate:
+
+```bash
+public auth login
+public accounts list
+public accounts set-default ACCOUNT_ID
+public portfolio show
+public market quotes AAPL MSFT
+```
+
+Most account-scoped commands use the configured default account. You can override it with
+`--account-id ACCOUNT_ID` or `PUBLIC_ACCOUNT_ID=ACCOUNT_ID`.
+
+## Important Disclosures
+
+This CLI is a developer tool for interacting with the Public API. It is not investment,
+financial, legal, tax, accounting, or trading advice, and it does not recommend any
+security, strategy, account type, order type, or transaction.
+
+Trading involves risk, including the possible loss of principal. You are responsible for
+reviewing all request payloads, account IDs, symbols, quantities, prices, order sides,
+time-in-force values, and other order instructions before submitting a trading command.
+
+Order placement, replacement, and cancellation requests may be asynchronous. A successful
+API response confirms submission to the API, not execution, cancellation, fill price,
+availability, or final order state. Always verify order status after submitting,
+replacing, or cancelling an order.
+
+Market data, quotes, option chains, greeks, account data, and preflight calculations are
+provided for informational and operational use through the API. They may be incomplete,
+delayed, unavailable, or different from final execution values.
+
+You are responsible for complying with all applicable laws, regulations, exchange rules,
+API terms, account agreements, and internal policies that apply to your use of this CLI.
+Do not use this tool unless you are authorized to access the relevant account and API
+credentials.
+
+Personal secrets and access tokens can authorize account access and trading activity.
+Keep them private, do not commit them to source control, and rotate or revoke them if
+you believe they were exposed.
+
+## Authenticate
+
+Generate a personal secret from Public, then run:
+
+```bash
+public auth login
+```
+
+The access token is stored with your OS keychain when available. If no keychain backend
+is available, the CLI falls back to a user-only config file.
+
+Access tokens are short-lived. To let the CLI refresh them automatically, opt in to
+storing your personal secret:
+
+```bash
+public auth login --store-secret
+```
+
+Because the personal secret is long-lived, this is optional. The CLI stores it in your
+OS keychain when available, otherwise it falls back to a user-only config file.
+
+After that, secured commands automatically mint a fresh access token before the current
+token expires or after a `401 Unauthorized` response. You can also refresh manually:
+
+```bash
+public auth refresh
+```
+
+You can also bypass stored credentials for automation:
+
+```bash
+PUBLIC_ACCESS_TOKEN=ey... public accounts list
+PUBLIC_PERSONAL_SECRET=... public accounts list
+```
+
+Remove stored credentials with:
+
+```bash
+public auth logout
+public auth logout --all
+```
+
+## Default Account
+
+Most API operations require the `accountId` returned by `public accounts list`. You can
+store a default account once:
+
+```bash
+public accounts set-default ACCOUNT_ID
+public accounts get-default
+```
+
+Then omit `--account-id` from account-scoped commands:
+
+```bash
+public portfolio show
+public market quotes AAPL MSFT
+public order get ORDER_ID
+```
+
+You can override the default at any time:
+
+```bash
+public portfolio show --account-id ACCOUNT_ID
+PUBLIC_ACCOUNT_ID=ACCOUNT_ID public portfolio show
+public accounts clear-default
+```
+
+## Example Commands
+
+```bash
+public accounts list
+public accounts set-default ACCOUNT_ID
+public portfolio show
+public history list --page-size 25
+public instruments get AAPL EQUITY
+public market quotes AAPL MSFT --type EQUITY
+public market option-expirations AAPL
+public market option-chain AAPL 2026-05-15
+public options greeks "AAPL  260515C00200000"
+```
+
+Trading requests use JSON files so the exact payload is visible before submission:
+
+```bash
+public order preflight-single --file examples/order.single-leg.market-buy.json
+public order place --file examples/order.single-leg.market-buy.json
+public order get ORDER_ID
+public order cancel ORDER_ID
+```
+
+Trading commands prompt before submitting order placement, replacement, or cancellation
+requests. Use `--yes` only when your automation has already performed equivalent
+validation and approval.
+
+## JSON Output
+
+Use `--json` before the command group to print raw JSON:
+
+```bash
+public --json accounts list
+public --json market quotes AAPL MSFT
+```
+
+## Configuration
+
+The CLI supports these environment variables:
+
+```bash
+PUBLIC_ACCESS_TOKEN=...
+PUBLIC_PERSONAL_SECRET=...
+PUBLIC_ACCOUNT_ID=...
+PUBLIC_API_BASE_URL=https://api.public.com
+PUBLIC_AUTO_REFRESH=true
+```
+
+`PUBLIC_API_BASE_URL` is optional and defaults to `https://api.public.com`.
+
+## Upgrade
+
+```bash
+pipx upgrade publicdotcom-cli
+# or
+uv tool upgrade publicdotcom-cli
+```
+
+## Development
+
+For local development from a checkout:
+
+```bash
+uv sync --extra dev
+uv run public --help
+uv run pytest
+```
+
+## Regenerate The OpenAPI Client
+
+The package ships with a generated API client. Contributors who need to regenerate it
+must place the local OpenAPI spec at the repository root as `spec.yaml`, then run:
+
+```bash
+uv run python scripts/generate_client.py
+```
+
+The raw spec uses `*/*` for many JSON responses, which some Python generators do not
+parse as JSON. The regeneration script normalizes those response content types before
+running `openapi-python-client`. This requires network access the first time because it
+uses `uvx openapi-python-client`.

publicdotcom_cli-1.0.0/examples/order.single-leg.market-buy.json

@@ -0,0 +1,12 @@
+{
+  "instrument": {
+    "symbol": "AAPL",
+    "type": "EQUITY"
+  },
+  "orderSide": "BUY",
+  "orderType": "MARKET",
+  "expiration": {
+    "timeInForce": "DAY"
+  },
+  "quantity": "1"
+}

publicdotcom_cli-1.0.0/pyproject.toml

@@ -0,0 +1,77 @@
+[project]
+name = "publicdotcom-cli"
+version = "1.0.0"
+description = "Command-line client for the Public.com Trading API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+authors = [
+    { name = "Public.com", email = "developers@public.com" },
+]
+maintainers = [
+    { name = "Public.com", email = "developers@public.com" },
+]
+keywords = [
+    "api",
+    "brokerage",
+    "cli",
+    "crypto",
+    "options",
+    "public.com",
+    "stocks",
+    "trading",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "attrs>=23.2.0",
+    "httpx>=0.28.0",
+    "keyring>=25.0.0",
+    "platformdirs>=4.0.0",
+    "python-dateutil>=2.8.2",
+    "rich>=13.7.0",
+    "typer>=0.16.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "ruff>=0.11.0",
+]
+
+[project.scripts]
+public = "publicdotcom_cli.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/publicdotcom/publicdotcom-cli"
+Repository = "https://github.com/publicdotcom/publicdotcom-cli"
+Issues = "https://github.com/publicdotcom/publicdotcom-cli/issues"
+"Public.com API" = "https://public.com/api"
+
+[build-system]
+requires = ["hatchling>=1.24.0"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/publicdotcom_cli"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+extend-exclude = ["src/publicdotcom_cli/_generated"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

publicdotcom_cli-1.0.0/scripts/generate_client.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+import re
+import shutil
+import subprocess
+import tempfile
+from pathlib import Path
+
+ROOT = Path(__file__).resolve().parents[1]
+SPEC_PATH = ROOT / "spec.yaml"
+OUTPUT_PATH = ROOT / "src" / "publicdotcom_cli" / "_generated"
+
+
+def normalized_spec_text() -> str:
+    if not SPEC_PATH.exists():
+        raise SystemExit(
+            f"OpenAPI spec not found at {SPEC_PATH}. "
+            "Place the local, uncommitted spec at the repository root as spec.yaml."
+        )
+    text = SPEC_PATH.read_text(encoding="utf-8")
+    return re.sub(r"^(\s*)'\*/\*':", r"\1application/json:", text, flags=re.MULTILINE)
+
+
+def main() -> None:
+    with tempfile.TemporaryDirectory() as tmp:
+        normalized_spec = Path(tmp) / "spec.codegen.yaml"
+        normalized_spec.write_text(normalized_spec_text(), encoding="utf-8")
+        subprocess.run(
+            [
+                "uvx",
+                "openapi-python-client",
+                "generate",
+                "--path",
+                str(normalized_spec),
+                "--output-path",
+                str(OUTPUT_PATH),
+                "--overwrite",
+                "--meta",
+                "none",
+            ],
+            check=True,
+            cwd=ROOT,
+        )
+
+    shutil.rmtree(OUTPUT_PATH / ".ruff_cache", ignore_errors=True)
+
+
+if __name__ == "__main__":
+    main()

publicdotcom_cli-1.0.0/src/publicdotcom_cli/__init__.py

@@ -0,0 +1,3 @@
+"""Command-line tools for the Public API."""
+
+__version__ = "1.0.0"

publicdotcom_cli-1.0.0/src/publicdotcom_cli/__main__.py

@@ -0,0 +1,5 @@
+from publicdotcom_cli.cli import main
+
+
+if __name__ == "__main__":
+    main()

publicdotcom_cli-1.0.0/src/publicdotcom_cli/_generated/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing User Api Gateway REST API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

publicdotcom_cli-1.0.0/src/publicdotcom_cli/_generated/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

publicdotcom_cli-1.0.0/src/publicdotcom_cli/_generated/api/account_details/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""