ganaka-sdk 0.1.2__tar.gz

ganaka_sdk-0.1.2/.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: Release
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: release
+      cancel-in-progress: false
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - run: uv sync
+
+      - run: uv run pytest -v
+
+      - name: Verify baseline tag exists
+        run: |
+          git fetch --tags --force
+          if ! git tag -l 'v*' | grep -q .; then
+            echo "::error::No v* tag found. Seed baseline: git tag v0.1.0 <commit> && git push origin v0.1.0"
+            exit 1
+          fi
+          echo "Found tags: $(git tag -l 'v*' | tr '\n' ' ')"
+
+      - name: Semantic version release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v10.5.3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions[bot]"
+          git_committer_email: "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Publish to PyPI
+        if: steps.release.outputs.released == 'true'
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
+        run: |
+          uv build
+          uv publish

ganaka_sdk-0.1.2/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*$py.class
+.venv/
+dist/
+build/
+*.egg-info/
+.uv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/

ganaka_sdk-0.1.2/.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.10.0
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]

ganaka_sdk-0.1.2/.python-version

@@ -0,0 +1 @@
+3.11

ganaka_sdk-0.1.2/.vscode/terminals.json

@@ -0,0 +1,29 @@
+{
+  "autorun": false,
+  "terminals": [
+    {
+      "name": "SDK: Sync",
+      "focus": true,
+      "onlySingle": true,
+      "command": "uv sync"
+    },
+    {
+      "name": "SDK: Test",
+      "focus": true,
+      "onlySingle": true,
+      "command": "uv run pytest -v"
+    },
+    {
+      "name": "SDK: Test Coverage",
+      "focus": true,
+      "onlySingle": true,
+      "command": "uv run pytest -v --cov=ganaka --cov-report=term-missing"
+    },
+    {
+      "name": "SDK: Build",
+      "focus": true,
+      "onlySingle": true,
+      "command": "uv build"
+    }
+  ]
+}

ganaka_sdk-0.1.2/CHANGELOG.md

@@ -0,0 +1,32 @@
+# CHANGELOG
+
+<!-- version list -->
+
+## v0.1.2 (2026-06-16)
+
+
+## v0.1.1 (2026-06-16)
+
+### Bug Fixes
+
+- Remove unused build command from pyproject.toml and maintain semantic release configuration.
+  ([`106fa0c`](https://github.com/ganakadev/sdk/commit/106fa0c2dd3db1f16dfad8accdf8abdf576e4090))
+
+- Update GitHub Actions workflow to fetch all tags and improve error messaging for baseline tag
+  verification.
+  ([`76127f9`](https://github.com/ganakadev/sdk/commit/76127f9a441dc4d3afe3dcc4553d743f345b02c0))
+
+- Update GitHub Actions workflow to fetch tags and clean up VSCode terminal configurations by
+  removing unused commands.
+  ([`8be3351`](https://github.com/ganakadev/sdk/commit/8be33513fbc749c4424558f817721585ce353fcf))
+
+### Chores
+
+- Add initial test suite for Ganaka SDK, including version check, client instantiation, and error
+  handling for unknown brokers.
+  ([`e286115`](https://github.com/ganakadev/sdk/commit/e286115387ea828f98add39c4d37cca576f31e5f))
+
+
+## v0.1.0 (2026-06-16)
+
+- Initial Release

ganaka_sdk-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ganaka Dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ganaka_sdk-0.1.2/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: ganaka-sdk
+Version: 0.1.2
+Summary: Python SDK for Ganaka - broker access and strategy tracking
+Project-URL: Homepage, https://github.com/ganakadev/sdk
+Project-URL: Repository, https://github.com/ganakadev/sdk
+Project-URL: Issues, https://github.com/ganakadev/sdk/issues
+Author-email: Ganaka Dev <dev@ganaka.dev>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: broker,dhan,sdk,strategy,trading
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# Ganaka Python SDK
+
+Python SDK for [Ganaka](https://github.com/ganakadev/sdk) — trade through brokers like Dhan, track strategy execution on the Ganaka platform, and store run results for analysis.
+
+## Requirements
+
+- Python 3.11+
+- [uv](https://docs.astral.sh/uv/) (recommended) or pip
+
+## Install
+
+From this repository (development):
+
+```bash
+cd sdk
+uv sync
+```
+
+Editable install:
+
+```bash
+uv pip install -e .
+```
+
+## Configuration
+
+| Variable / argument | Description |
+|---------------------|-------------|
+| `api_key` | Ganaka platform API key (Bearer token) |
+| `broker` | Broker adapter name (`dhan`) |
+| `broker_config.client_id` | Dhan client ID |
+| `broker_config.access_token` | Dhan access token (refreshed daily) |
+| `base_url` | Ganaka API URL (default: `http://localhost:3000`) |
+
+## Usage
+
+```python
+import asyncio
+
+from ganaka import Ganaka
+
+
+async def main() -> None:
+    async with Ganaka(
+        api_key="gk_your_key",
+        broker="dhan",
+        broker_config={
+            "client_id": "1100000001",
+            "access_token": "eyJ...",
+        },
+    ) as client:
+        # Broker: portfolio and orders
+        positions = await client.broker.get_positions()
+        holdings = await client.broker.get_holdings()
+
+        order = await client.broker.place_order(
+            security_id="1333",
+            exchange_segment="NSE_EQ",
+            transaction_type="BUY",
+            quantity=1,
+            product_type="INTRADAY",
+            order_type="LIMIT",
+            price=2500.0,
+        )
+
+        # Strategy tracking: log the flow of a run
+        run_id = await client.strategy.start_run(
+            strategy_id="breakout-nifty",
+            metadata={"timeframe": "5m"},
+        )
+        await client.strategy.log_entry(
+            signal="BUY",
+            instrument="RELIANCE",
+            reason="breakout above resistance",
+            extra={"price": 2500.0},
+        )
+        await client.strategy.end_run(status="completed")
+
+        # Persist final results to Ganaka database
+        await client.results.save(
+            strategy_id="breakout-nifty",
+            pnl=1200.50,
+            run_id=run_id,
+            trades=[{"symbol": "RELIANCE", "side": "BUY", "qty": 1}],
+            metrics={"win_rate": 0.62},
+        )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Project layout
+
+```
+src/ganaka/
+├── client.py          # Ganaka main client
+├── broker/            # Broker adapters (Dhan)
+├── strategy/          # Strategy run tracking
+├── storage/           # Result persistence
+└── exceptions.py      # SDK error types
+```
+
+## Development
+
+```bash
+uv sync
+uv run pre-commit install --hook-type commit-msg
+```
+
+If hook install fails with `core.hooksPath` set (e.g. after removing Husky), run `git config --local --unset-all core.hooksPath` and retry.
+
+```bash
+uv run python -c "from ganaka import Ganaka; print(Ganaka)"
+```
+
+### Commit messages
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/). After installing pre-commit hooks, every commit message is validated locally:
+
+```bash
+feat: add Dhan order book helper
+fix: handle expired access token
+chore: update dependencies
+```
+
+Dry-run a release locally (no changes made):
+
+```bash
+uv run semantic-release -v --noop version
+```
+
+## Releasing
+
+Releases are triggered manually via the **Release** GitHub Actions workflow (`workflow_dispatch`).
+
+1. Seed a baseline tag before the first release: `git tag v0.1.0 && git push origin v0.1.0`
+2. Merge conventional commits to `main`
+3. Run the **Release** workflow in GitHub Actions
+
+The workflow uses [python-semantic-release](https://python-semantic-release.readthedocs.io/) to bump `pyproject.toml`, update `CHANGELOG.md`, create a git tag and GitHub Release, then publish to PyPI with `uv publish`.
+
+### GitHub secrets
+
+| Secret | Purpose |
+|--------|---------|
+| `GITHUB_TOKEN` | Auto-provided; tags and GitHub Releases |
+| `UV_PUBLISH_TOKEN` | PyPI API token for `uv publish` |
+
+Optional: configure [PyPI Trusted Publisher](https://docs.pypi.org/trusted-publishers/) to avoid storing a token.
+
+## License
+
+MIT

ganaka_sdk-0.1.2/README.md

@@ -0,0 +1,154 @@
+# Ganaka Python SDK
+
+Python SDK for [Ganaka](https://github.com/ganakadev/sdk) — trade through brokers like Dhan, track strategy execution on the Ganaka platform, and store run results for analysis.
+
+## Requirements
+
+- Python 3.11+
+- [uv](https://docs.astral.sh/uv/) (recommended) or pip
+
+## Install
+
+From this repository (development):
+
+```bash
+cd sdk
+uv sync
+```
+
+Editable install:
+
+```bash
+uv pip install -e .
+```
+
+## Configuration
+
+| Variable / argument | Description |
+|---------------------|-------------|
+| `api_key` | Ganaka platform API key (Bearer token) |
+| `broker` | Broker adapter name (`dhan`) |
+| `broker_config.client_id` | Dhan client ID |
+| `broker_config.access_token` | Dhan access token (refreshed daily) |
+| `base_url` | Ganaka API URL (default: `http://localhost:3000`) |
+
+## Usage
+
+```python
+import asyncio
+
+from ganaka import Ganaka
+
+
+async def main() -> None:
+    async with Ganaka(
+        api_key="gk_your_key",
+        broker="dhan",
+        broker_config={
+            "client_id": "1100000001",
+            "access_token": "eyJ...",
+        },
+    ) as client:
+        # Broker: portfolio and orders
+        positions = await client.broker.get_positions()
+        holdings = await client.broker.get_holdings()
+
+        order = await client.broker.place_order(
+            security_id="1333",
+            exchange_segment="NSE_EQ",
+            transaction_type="BUY",
+            quantity=1,
+            product_type="INTRADAY",
+            order_type="LIMIT",
+            price=2500.0,
+        )
+
+        # Strategy tracking: log the flow of a run
+        run_id = await client.strategy.start_run(
+            strategy_id="breakout-nifty",
+            metadata={"timeframe": "5m"},
+        )
+        await client.strategy.log_entry(
+            signal="BUY",
+            instrument="RELIANCE",
+            reason="breakout above resistance",
+            extra={"price": 2500.0},
+        )
+        await client.strategy.end_run(status="completed")
+
+        # Persist final results to Ganaka database
+        await client.results.save(
+            strategy_id="breakout-nifty",
+            pnl=1200.50,
+            run_id=run_id,
+            trades=[{"symbol": "RELIANCE", "side": "BUY", "qty": 1}],
+            metrics={"win_rate": 0.62},
+        )
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Project layout
+
+```
+src/ganaka/
+├── client.py          # Ganaka main client
+├── broker/            # Broker adapters (Dhan)
+├── strategy/          # Strategy run tracking
+├── storage/           # Result persistence
+└── exceptions.py      # SDK error types
+```
+
+## Development
+
+```bash
+uv sync
+uv run pre-commit install --hook-type commit-msg
+```
+
+If hook install fails with `core.hooksPath` set (e.g. after removing Husky), run `git config --local --unset-all core.hooksPath` and retry.
+
+```bash
+uv run python -c "from ganaka import Ganaka; print(Ganaka)"
+```
+
+### Commit messages
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/). After installing pre-commit hooks, every commit message is validated locally:
+
+```bash
+feat: add Dhan order book helper
+fix: handle expired access token
+chore: update dependencies
+```
+
+Dry-run a release locally (no changes made):
+
+```bash
+uv run semantic-release -v --noop version
+```
+
+## Releasing
+
+Releases are triggered manually via the **Release** GitHub Actions workflow (`workflow_dispatch`).
+
+1. Seed a baseline tag before the first release: `git tag v0.1.0 && git push origin v0.1.0`
+2. Merge conventional commits to `main`
+3. Run the **Release** workflow in GitHub Actions
+
+The workflow uses [python-semantic-release](https://python-semantic-release.readthedocs.io/) to bump `pyproject.toml`, update `CHANGELOG.md`, create a git tag and GitHub Release, then publish to PyPI with `uv publish`.
+
+### GitHub secrets
+
+| Secret | Purpose |
+|--------|---------|
+| `GITHUB_TOKEN` | Auto-provided; tags and GitHub Releases |
+| `UV_PUBLISH_TOKEN` | PyPI API token for `uv publish` |
+
+Optional: configure [PyPI Trusted Publisher](https://docs.pypi.org/trusted-publishers/) to avoid storing a token.
+
+## License
+
+MIT

ganaka_sdk-0.1.2/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "ganaka-sdk"
+version = "0.1.2"
+description = "Python SDK for Ganaka - broker access and strategy tracking"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [{ name = "Ganaka Dev", email = "dev@ganaka.dev" }]
+keywords = ["trading", "broker", "dhan", "strategy", "sdk"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business :: Financial :: Investment",
+]
+dependencies = ["httpx>=0.27"]
+
+[project.urls]
+Homepage = "https://github.com/ganakadev/sdk"
+Repository = "https://github.com/ganakadev/sdk"
+Issues = "https://github.com/ganakadev/sdk/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ganaka"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "pytest-cov>=4.0",
+    "python-semantic-release>=10.5",
+    "pre-commit>=4.0",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+commit_parser = "conventional"
+allow_zero_version = true
+
+[tool.semantic_release.branches.main]
+match = "main"
+prerelease = false
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG.md"
+output_format = "md"
+
+[tool.semantic_release.changelog.environment]
+keep_trailing_newline = true

ganaka_sdk-0.1.2/src/ganaka/__init__.py

@@ -0,0 +1,42 @@
+"""Ganaka Python SDK — broker access and strategy tracking.
+
+Install::
+
+    pip install ganaka
+
+Quick start::
+
+    from ganaka import Ganaka
+
+    client = Ganaka(
+        api_key="gk_...",
+        broker="dhan",
+        broker_config={
+            "client_id": "1100000001",
+            "access_token": "eyJ...",
+        },
+    )
+
+    positions = await client.broker.get_positions()
+"""
+
+from ganaka.client import Ganaka
+from ganaka.exceptions import (
+    AuthenticationError,
+    BrokerAPIError,
+    ConfigurationError,
+    GanakaError,
+    ResultStorageError,
+    StrategyTrackingError,
+)
+
+__all__ = [
+    "Ganaka",
+    "GanakaError",
+    "ConfigurationError",
+    "AuthenticationError",
+    "BrokerAPIError",
+    "StrategyTrackingError",
+    "ResultStorageError",
+]
+__version__ = "0.1.0"