orbiter-crypto 0.2.0__tar.gz

orbiter_crypto-0.2.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+buy_me_a_coffee: borghei

orbiter_crypto-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  publish:
+    name: Build & Publish
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Upload to GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload ${{ github.event.release.tag_name }} dist/*

orbiter_crypto-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+      - name: Lint
+        run: ruff check src/ tests/
+      - name: Test
+        run: pytest

orbiter_crypto-0.2.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+venv/
+dist/
+build/
+*.egg-info/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+*.egg
+.DS_Store

orbiter_crypto-0.2.0/CLAUDE.md

@@ -0,0 +1,29 @@
+# Orbiter Development Guide
+
+## Setup
+uv venv && source .venv/bin/activate && uv pip install -e ".[dev,dashboard]"
+
+## Commands
+- Run tests: pytest
+- Run single test: pytest tests/test_metrics.py::test_sharpe_ratio -v
+- Lint: ruff check src/ tests/
+- Format: ruff format src/ tests/
+- CLI: orbiter optimize BTC ETH SOL --strategy max-sharpe
+- Dashboard: streamlit run src/orbiter/dashboard.py
+
+## Architecture
+- src/orbiter/data.py — price fetching via ccxt
+- src/orbiter/metrics.py — pure functions, no side effects
+- src/orbiter/covariance.py — covariance matrix estimators
+- src/orbiter/optimize.py — PortfolioOptimizer class, all strategies
+- src/orbiter/backtest.py — walk-forward engine
+- src/orbiter/cli.py — Click CLI
+- src/orbiter/dashboard.py — Streamlit app
+
+## Conventions
+- Log returns throughout (not simple returns)
+- Type hints on all public functions
+- Docstrings: Google style, only where logic isn't obvious
+- All optimization assumes long-only (no short selling)
+- Default periods_per_year=365 (crypto trades 24/7)
+- Default covariance method: ledoit-wolf

orbiter_crypto-0.2.0/LICENSE

@@ -0,0 +1,65 @@
+Commons Clause License Condition v1.0 + MIT
+
+The Software is provided to you by the Licensor under the License, as
+defined below, subject to the following condition.
+
+Without limiting other conditions in the License, the grant of rights under
+the License will not include, and the License does not grant to you, the
+right to Sell the Software.
+
+For purposes of the foregoing, "Sell" means practicing any or all of the
+rights granted to you under the License to provide to third parties, for a
+fee or other consideration (including without limitation fees for hosting or
+consulting/support services related to the Software), a product or service
+whose value derives, entirely or substantially, from the functionality of
+the Software. Any license notice or attribution required by the License must
+also include this Commons Clause License Condition notice.
+
+Software: Orbiter
+License: MIT
+Licensor: Brian Borghei (borghei)
+
+---
+
+MIT License
+
+Copyright (c) 2025-2026 Brian Borghei
+
+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, and distribute 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, this permission notice, and the Commons Clause
+condition 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.
+
+---
+
+PLAIN LANGUAGE SUMMARY (not a legal substitute):
+
+  You CAN:
+    - Use this software freely in open-source projects
+    - Use this software for personal, educational, and internal business use
+    - Modify, fork, and distribute the software
+    - Use the tools and modules in your own workflows
+
+  You CANNOT:
+    - Sell this software or substantially similar copies of it
+    - Repackage Orbiter as a paid product or service
+    - Offer a commercial hosted service whose primary value comes from this software
+    - Remove the license or attribution notices
+
+  You MUST:
+    - Include this license in any copies or distributions
+    - Give attribution to the original project