growpanel 0.1.0__tar.gz

growpanel-0.1.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: growpanel
+Version: 0.1.0
+Summary: Python SDK for the GrowPanel subscription analytics REST API
+Project-URL: Homepage, https://growpanel.io
+Project-URL: Documentation, https://api.growpanel.io/docs
+Project-URL: Repository, https://github.com/growpanel/growpanel-sdk-python
+Author: GrowPanel ApS
+License: MIT
+Keywords: arr,churn,growpanel,metrics,mrr,saas,subscription-analytics
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: attrs>=24.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: python-dateutil>=2.8
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: openapi-python-client>=0.21; extra == 'dev'
+Requires-Dist: twine>=5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# growpanel (Python)
+
+Official Python SDK for the [GrowPanel](https://growpanel.io) subscription analytics REST API.
+
+```bash
+pip install growpanel
+```
+
+```python
+from growpanel import GrowPanel
+
+gp = GrowPanel(api_key="gp_...")
+
+summary = gp.reports.get_summary()
+print(summary.summary.mrr_current)
+
+mrr = gp.reports.get_mrr(date="20260101-20260531", interval="month")
+for period in mrr.result:
+    print(period.date, period.total_mrr)
+```
+
+## Auth
+
+Issue a key in **app.growpanel.io → Account → API keys**. Pass it as `api_key=` when constructing the client; it\'s sent as `Authorization: Bearer <key>` on every request.
+
+## Surfaces
+
+The SDK mirrors the [interactive docs](https://api.growpanel.io/docs):
+
+**Analytics (read-only):**
+- `gp.reports.*` — MRR, leads, cohorts, cashflow, retention, churn
+- `gp.customers.*` — list + detail (analytics view)
+- `gp.plans.*` — list plans
+
+**Account & integrations:**
+- `gp.profile.*`, `gp.notifications.*`, `gp.webhooks.*`
+
+**Data ingestion (CRUD on a data source):**
+- `gp.data.customers.*` — create / read / update / delete raw customer rows
+- `gp.data.plans.*` — raw plan CRUD
+- `gp.data.plan_groups.*` — group plans together
+- `gp.data.segments.*` — saved filter combinations
+- `gp.data.invoices.*` — raw invoice CRUD
+- `gp.data.sources.*` — connected billing systems
+
+`gp.data.*` mirrors the `/data/*` URL prefix and keeps the ingestion API visually separate from the analytics surfaces.
+
+For anything not exposed as a named method, `gp.raw` is the generated module tree — every endpoint in the OpenAPI spec is reachable from there.
+
+## Generating from the live spec
+
+```bash
+pip install -e ".[dev]"
+openapi-python-client generate \
+    --url https://api-dev.growpanel.io/openapi.json \
+    --config openapi-python-client.config.yaml \
+    --overwrite
+```
+
+Output lands in `src/growpanel/_generated/`. In CI, this runs automatically on every API change.
+
+## Errors
+
+```python
+from growpanel import GrowPanel, GrowPanelError
+
+gp = GrowPanel(api_key="...")
+try:
+    gp.customers.detail(id="cus_doesnotexist")
+except GrowPanelError as err:
+    if err.status == 404:
+        ...  # handle not-found
+    raise
+```
+
+## Interactive docs
+
+The full reference (with try-it-out) lives at [api.growpanel.io/docs](https://api.growpanel.io/docs).

growpanel-0.1.0/README.md

@@ -0,0 +1,78 @@
+# growpanel (Python)
+
+Official Python SDK for the [GrowPanel](https://growpanel.io) subscription analytics REST API.
+
+```bash
+pip install growpanel
+```
+
+```python
+from growpanel import GrowPanel
+
+gp = GrowPanel(api_key="gp_...")
+
+summary = gp.reports.get_summary()
+print(summary.summary.mrr_current)
+
+mrr = gp.reports.get_mrr(date="20260101-20260531", interval="month")
+for period in mrr.result:
+    print(period.date, period.total_mrr)
+```
+
+## Auth
+
+Issue a key in **app.growpanel.io → Account → API keys**. Pass it as `api_key=` when constructing the client; it\'s sent as `Authorization: Bearer <key>` on every request.
+
+## Surfaces
+
+The SDK mirrors the [interactive docs](https://api.growpanel.io/docs):
+
+**Analytics (read-only):**
+- `gp.reports.*` — MRR, leads, cohorts, cashflow, retention, churn
+- `gp.customers.*` — list + detail (analytics view)
+- `gp.plans.*` — list plans
+
+**Account & integrations:**
+- `gp.profile.*`, `gp.notifications.*`, `gp.webhooks.*`
+
+**Data ingestion (CRUD on a data source):**
+- `gp.data.customers.*` — create / read / update / delete raw customer rows
+- `gp.data.plans.*` — raw plan CRUD
+- `gp.data.plan_groups.*` — group plans together
+- `gp.data.segments.*` — saved filter combinations
+- `gp.data.invoices.*` — raw invoice CRUD
+- `gp.data.sources.*` — connected billing systems
+
+`gp.data.*` mirrors the `/data/*` URL prefix and keeps the ingestion API visually separate from the analytics surfaces.
+
+For anything not exposed as a named method, `gp.raw` is the generated module tree — every endpoint in the OpenAPI spec is reachable from there.
+
+## Generating from the live spec
+
+```bash
+pip install -e ".[dev]"
+openapi-python-client generate \
+    --url https://api-dev.growpanel.io/openapi.json \
+    --config openapi-python-client.config.yaml \
+    --overwrite
+```
+
+Output lands in `src/growpanel/_generated/`. In CI, this runs automatically on every API change.
+
+## Errors
+
+```python
+from growpanel import GrowPanel, GrowPanelError
+
+gp = GrowPanel(api_key="...")
+try:
+    gp.customers.detail(id="cus_doesnotexist")
+except GrowPanelError as err:
+    if err.status == 404:
+        ...  # handle not-found
+    raise
+```
+
+## Interactive docs
+
+The full reference (with try-it-out) lives at [api.growpanel.io/docs](https://api.growpanel.io/docs).

growpanel-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "growpanel"
+version = "0.1.0"
+description = "Python SDK for the GrowPanel subscription analytics REST API"
+readme = "README.md"
+license = { text = "MIT" }
+authors = [{ name = "GrowPanel ApS" }]
+requires-python = ">=3.9"
+keywords = ["growpanel", "saas", "metrics", "mrr", "arr", "churn", "subscription-analytics"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Office/Business :: Financial",
+]
+dependencies = [
+    "httpx >= 0.27",
+    "attrs >= 24.0",
+    "python-dateutil >= 2.8",
+]
+
+[project.urls]
+Homepage = "https://growpanel.io"
+Documentation = "https://api.growpanel.io/docs"
+Repository = "https://github.com/growpanel/growpanel-sdk-python"
+
+[project.optional-dependencies]
+dev = [
+    "openapi-python-client >= 0.21",
+    "build >= 1.0",
+    "twine >= 5.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/growpanel"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/growpanel", "README.md", "LICENSE"]

growpanel-0.1.0/src/growpanel/__init__.py

@@ -0,0 +1,15 @@
+"""GrowPanel Python SDK — subscription analytics REST API client.
+
+Usage:
+    from growpanel import GrowPanel
+
+    gp = GrowPanel(api_key="gp_...")
+    summary = gp.reports.summary()
+    print(summary.mrr_current)
+"""
+
+from .client import GrowPanel
+from .errors import GrowPanelError
+
+__all__ = ["GrowPanel", "GrowPanelError"]
+__version__ = "0.1.0"

growpanel-0.1.0/src/growpanel/_generated/__init__.py

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

growpanel-0.1.0/src/growpanel/_generated/api/__init__.py

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

growpanel-0.1.0/src/growpanel/_generated/api/customers/__init__.py

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