pycharting 0.2.0__tar.gz → 0.2.3__tar.gz

pycharting-0.2.3/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.1
+Name: pycharting
+Version: 0.2.3
+Summary: High-performance financial charting library for OHLC data visualization with technical indicators
+Home-page: https://github.com/alihaskar/pycharting
+License: MIT
+Keywords: charting,finance,ohlc,technical-indicators,trading,visualization
+Author: ali askar
+Author-email: 26202651+alihaskar@users.noreply.github.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Dist: fastapi (>=0.115.0,<1.0.0)
+Requires-Dist: numpy (>=1.26.0,<3.0.0)
+Requires-Dist: pandas (>=2.2.0,<3.0.0)
+Requires-Dist: pydantic (>=2.7.0,<3.0.0)
+Requires-Dist: pytz (>=2024.1,<2026.0)
+Requires-Dist: uvicorn[standard] (>=0.24.0,<1.0.0)
+Project-URL: Repository, https://github.com/alihaskar/pycharting
+Description-Content-Type: text/markdown
+
+# PyCharting
+
+High‑performance financial charting library for OHLC data visualization with technical indicators.
+
+## Overview
+
+PyCharting lets you render large OHLC time series (hundreds of thousands to millions of candles) in the browser with a single Python call.  
+It runs a lightweight FastAPI server locally, streams your data to a uPlot-based frontend, and gives you an interactive viewport with overlays and indicator subplots.
+
+![PyCharting demo](demo.png)
+
+## Features
+
+- **Million‑point OHLC charts**: optimized for large numeric indices and dense intraday data.
+- **Overlays on price**: moving averages, EMAs, or any arbitrary overlay series.
+- **Indicator subplots**: RSI-style and stochastic-style oscillators rendered as separate panels.
+- **Viewport management**: server‑side slicing and caching for smooth pan/zoom on huge arrays.
+- **FastAPI + uPlot stack**: Python on the backend, ultra‑light JS on the frontend.
+- **Simple Python API**: one main entry point, `plot(...)`, plus helpers to manage the server.
+
+## Installation
+
+### From PyPI
+
+Install the latest released version from PyPI:
+
+```bash
+pip install pycharting
+```
+
+This will install the `pycharting` package along with its runtime dependencies (`numpy`, `pandas`, `fastapi`, `uvicorn`, and friends).
+
+### From source
+
+If you want to develop or run against `main`:
+
+```bash
+git clone https://github.com/alihaskar/pycharting.git
+cd pycharting
+pip install -e .
+```
+
+If you use Poetry instead of pip:
+
+```bash
+git clone https://github.com/alihaskar/pycharting.git
+cd pycharting
+poetry install
+```
+
+## Quick start
+
+The primary API is a single `plot` function that takes OHLC arrays (plus optional overlays and subplots), starts a local server, and opens your default browser on the interactive chart.
+
+When you run this script, PyCharting will:
+
+- spin up a local FastAPI server on an available port,
+- register your OHLC series and overlays in a session,
+- open your default browser to a minimal full‑page chart UI showing price and overlays.
+
+## Overlays vs subplots
+
+Once you have your OHLC series, you pass additional series to `plot` in two different ways:
+
+```python
+overlays = {
+    "SMA_50": sma(close, 50),      # rendered on top of price
+    "EMA_200": ema(close, 200),
+}
+
+subplots = {
+    "RSI_like": rsi_like_series,   # rendered in its own panel below price
+    "Stoch_like": stoch_series,
+}
+
+plot(
+    index,
+    open_,
+    high,
+    low,
+    close,
+    overlays=overlays,
+    subplots=subplots,
+)
+```
+
+- **Overlays** share the same y‑axis as price and are drawn directly on the candlestick chart (moving averages, bands, signals on price).
+- **Subplots** are stacked independent charts below the main panel with their own y‑scales (oscillators, volume, breadth measures).
+
+See `demo.py` for a full example that generates synthetic data and wires up both overlays and indicator-style subplots.
+
+Run the demo from the project root:
+
+```bash
+python demo.py
+```
+
+You should see something similar to the screenshot above: a price panel with overlays, plus RSI-like and stochastic-like subplots underneath.
+
+## Python API
+
+The public API is intentionally small and focused. All functions are available from the top-level `pycharting` package.
+
+### `plot`
+
+```python
+from typing import Dict, Any, Optional, Union
+
+import numpy as np
+import pandas as pd
+from pycharting import plot
+
+ArrayLike = Union[np.ndarray, pd.Series, list]
+
+result: Dict[str, Any] = plot(
+    index: ArrayLike,
+    open: ArrayLike,
+    high: ArrayLike,
+    low: ArrayLike,
+    close: ArrayLike,
+    overlays: Optional[Dict[str, ArrayLike]] = None,
+    subplots: Optional[Dict[str, ArrayLike]] = None,
+    session_id: str = "default",
+    port: Optional[int] = None,
+    open_browser: bool = True,
+    server_timeout: float = 2.0,
+)
+```
+
+- **index**: numeric or datetime-like x-axis values (internally treated as numeric indices).
+- **open/high/low/close**: price series of identical length.
+- **overlays**: mapping of overlay name to series (same length as `close`), rendered on the main price chart.
+- **subplots**: mapping of subplot name to series, rendered as additional charts stacked vertically.
+- **session_id**: identifier for the data session; can be used to host multiple concurrent charts.
+- **port**: optional port override; if `None`, PyCharting picks an available port.
+- **open_browser**: if `False`, you get the URL back in `result["url"]` but the browser is not opened automatically.
+
+The returned dict includes:
+
+- `status`: `"success"` or `"error"`,
+- `url`: full chart URL (including session query),
+- `server_url`: base FastAPI server URL,
+- `session_id`: the session identifier you passed in,
+- `data_points`: number of OHLC rows,
+- `server_running`: boolean.
+
+### `stop_server`
+
+```python
+from pycharting import stop_server
+
+stop_server()
+```
+
+Stops the active chart server if it is running. This is useful in long‑running processes and demos to clean up after you are done exploring charts.
+
+### `get_server_status`
+
+```python
+from pycharting import get_server_status
+
+status = get_server_status()
+print(status)
+```
+
+Returns a small dict with:
+
+- `running`: whether the server is alive,
+- `server_info`: host/port and other metadata if running,
+- `active_sessions`: number of registered data sessions.
+
+## Project structure
+
+The library follows a modern `src/` layout:
+
+```
+pycharting/
+├── src/
+│   ├── core/         # Chart server lifecycle and internals
+│   ├── data/         # Data ingestion, validation, and slicing
+│   ├── api/          # FastAPI routes and Python API surface
+│   └── web/          # Static frontend (HTML + JS for charts)
+├── tests/            # Test suite
+├── data/             # Sample CSVs and fixtures
+└── pyproject.toml    # Project configuration
+```
+
+## Contributing
+
+Contributions, bug reports, and feature suggestions are welcome. Please open an issue or pull request on GitHub.
+
+Basic workflow:
+
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feature/my-feature`.
+3. Make changes and add tests.
+4. Run the test suite.
+5. Open a pull request against `main`.
+
+## License
+
+PyCharting is licensed under the MIT License.
+
+## Links
+
+- **PyPI**: `https://pypi.org/project/pycharting/`
+- **Source**: `https://github.com/alihaskar/pycharting`
+- **Issues**: `https://github.com/alihaskar/pycharting/issues`
+

pycharting-0.2.3/README.md

@@ -0,0 +1,208 @@
+# PyCharting
+
+High‑performance financial charting library for OHLC data visualization with technical indicators.
+
+## Overview
+
+PyCharting lets you render large OHLC time series (hundreds of thousands to millions of candles) in the browser with a single Python call.  
+It runs a lightweight FastAPI server locally, streams your data to a uPlot-based frontend, and gives you an interactive viewport with overlays and indicator subplots.
+
+![PyCharting demo](demo.png)
+
+## Features
+
+- **Million‑point OHLC charts**: optimized for large numeric indices and dense intraday data.
+- **Overlays on price**: moving averages, EMAs, or any arbitrary overlay series.
+- **Indicator subplots**: RSI-style and stochastic-style oscillators rendered as separate panels.
+- **Viewport management**: server‑side slicing and caching for smooth pan/zoom on huge arrays.
+- **FastAPI + uPlot stack**: Python on the backend, ultra‑light JS on the frontend.
+- **Simple Python API**: one main entry point, `plot(...)`, plus helpers to manage the server.
+
+## Installation
+
+### From PyPI
+
+Install the latest released version from PyPI:
+
+```bash
+pip install pycharting
+```
+
+This will install the `pycharting` package along with its runtime dependencies (`numpy`, `pandas`, `fastapi`, `uvicorn`, and friends).
+
+### From source
+
+If you want to develop or run against `main`:
+
+```bash
+git clone https://github.com/alihaskar/pycharting.git
+cd pycharting
+pip install -e .
+```
+
+If you use Poetry instead of pip:
+
+```bash
+git clone https://github.com/alihaskar/pycharting.git
+cd pycharting
+poetry install
+```
+
+## Quick start
+
+The primary API is a single `plot` function that takes OHLC arrays (plus optional overlays and subplots), starts a local server, and opens your default browser on the interactive chart.
+
+When you run this script, PyCharting will:
+
+- spin up a local FastAPI server on an available port,
+- register your OHLC series and overlays in a session,
+- open your default browser to a minimal full‑page chart UI showing price and overlays.
+
+## Overlays vs subplots
+
+Once you have your OHLC series, you pass additional series to `plot` in two different ways:
+
+```python
+overlays = {
+    "SMA_50": sma(close, 50),      # rendered on top of price
+    "EMA_200": ema(close, 200),
+}
+
+subplots = {
+    "RSI_like": rsi_like_series,   # rendered in its own panel below price
+    "Stoch_like": stoch_series,
+}
+
+plot(
+    index,
+    open_,
+    high,
+    low,
+    close,
+    overlays=overlays,
+    subplots=subplots,
+)
+```
+
+- **Overlays** share the same y‑axis as price and are drawn directly on the candlestick chart (moving averages, bands, signals on price).
+- **Subplots** are stacked independent charts below the main panel with their own y‑scales (oscillators, volume, breadth measures).
+
+See `demo.py` for a full example that generates synthetic data and wires up both overlays and indicator-style subplots.
+
+Run the demo from the project root:
+
+```bash
+python demo.py
+```
+
+You should see something similar to the screenshot above: a price panel with overlays, plus RSI-like and stochastic-like subplots underneath.
+
+## Python API
+
+The public API is intentionally small and focused. All functions are available from the top-level `pycharting` package.
+
+### `plot`
+
+```python
+from typing import Dict, Any, Optional, Union
+
+import numpy as np
+import pandas as pd
+from pycharting import plot
+
+ArrayLike = Union[np.ndarray, pd.Series, list]
+
+result: Dict[str, Any] = plot(
+    index: ArrayLike,
+    open: ArrayLike,
+    high: ArrayLike,
+    low: ArrayLike,
+    close: ArrayLike,
+    overlays: Optional[Dict[str, ArrayLike]] = None,
+    subplots: Optional[Dict[str, ArrayLike]] = None,
+    session_id: str = "default",
+    port: Optional[int] = None,
+    open_browser: bool = True,
+    server_timeout: float = 2.0,
+)
+```
+
+- **index**: numeric or datetime-like x-axis values (internally treated as numeric indices).
+- **open/high/low/close**: price series of identical length.
+- **overlays**: mapping of overlay name to series (same length as `close`), rendered on the main price chart.
+- **subplots**: mapping of subplot name to series, rendered as additional charts stacked vertically.
+- **session_id**: identifier for the data session; can be used to host multiple concurrent charts.
+- **port**: optional port override; if `None`, PyCharting picks an available port.
+- **open_browser**: if `False`, you get the URL back in `result["url"]` but the browser is not opened automatically.
+
+The returned dict includes:
+
+- `status`: `"success"` or `"error"`,
+- `url`: full chart URL (including session query),
+- `server_url`: base FastAPI server URL,
+- `session_id`: the session identifier you passed in,
+- `data_points`: number of OHLC rows,
+- `server_running`: boolean.
+
+### `stop_server`
+
+```python
+from pycharting import stop_server
+
+stop_server()
+```
+
+Stops the active chart server if it is running. This is useful in long‑running processes and demos to clean up after you are done exploring charts.
+
+### `get_server_status`
+
+```python
+from pycharting import get_server_status
+
+status = get_server_status()
+print(status)
+```
+
+Returns a small dict with:
+
+- `running`: whether the server is alive,
+- `server_info`: host/port and other metadata if running,
+- `active_sessions`: number of registered data sessions.
+
+## Project structure
+
+The library follows a modern `src/` layout:
+
+```
+pycharting/
+├── src/
+│   ├── core/         # Chart server lifecycle and internals
+│   ├── data/         # Data ingestion, validation, and slicing
+│   ├── api/          # FastAPI routes and Python API surface
+│   └── web/          # Static frontend (HTML + JS for charts)
+├── tests/            # Test suite
+├── data/             # Sample CSVs and fixtures
+└── pyproject.toml    # Project configuration
+```
+
+## Contributing
+
+Contributions, bug reports, and feature suggestions are welcome. Please open an issue or pull request on GitHub.
+
+Basic workflow:
+
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feature/my-feature`.
+3. Make changes and add tests.
+4. Run the test suite.
+5. Open a pull request against `main`.
+
+## License
+
+PyCharting is licensed under the MIT License.
+
+## Links
+
+- **PyPI**: `https://pypi.org/project/pycharting/`
+- **Source**: `https://github.com/alihaskar/pycharting`
+- **Issues**: `https://github.com/alihaskar/pycharting/issues`

{pycharting-0.2.0 → pycharting-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pycharting"
-version = "0.2.0"
+version = "0.2.3"
 description = "High-performance financial charting library for OHLC data visualization with technical indicators"
 authors = ["ali askar <26202651+alihaskar@users.noreply.github.com>"]
 readme = "README.md"
@@ -18,22 +18,28 @@ classifiers = [
     "Topic :: Office/Business :: Financial",
     "Topic :: Scientific/Engineering :: Visualization",
 ]
-packages = [{include = "charting", from = "src"}]
+
+# match your actual src layout: src/api, src/core, src/data, src/web
+packages = [
+    { include = "api", from = "src" },
+    { include = "core", from = "src" },
+    { include = "data", from = "src" },
+    { include = "web", from = "src" },
+]
 
 [tool.poetry.dependencies]
 python = "^3.12"
-fastapi = "^0.123.4"
-pandas = "^2.3.3"
-numpy = "^2.3.5"
-pydantic = "^2.12.5"
-uvicorn = "^0.38.0"
-pytz = "^2025.2"
-
+fastapi = ">=0.115.0,<1.0.0"
+pandas = ">=2.2.0,<3.0.0"
+numpy = ">=1.26.0,<3.0.0"
+pydantic = ">=2.7.0,<3.0.0"
+uvicorn = { version = ">=0.24.0,<1.0.0", extras = ["standard"] }
+pytz = ">=2024.1,<2026.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^9.0.1"
-httpx = "^0.28.1"
+pytest = ">=8.3.0,<9.0.0"
+httpx = ">=0.27.0,<0.29.0"
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.9.0"]
+build-backend = "poetry.core.masonry.api"

pycharting-0.2.3/src/api/__init__.py

@@ -0,0 +1 @@
+"""API endpoints for PyCharting."""