Metadata-Version: 2.4
Name: skipole-data
Version: 0.1.0a1
Summary: Python client for Skipole licensed-data discovery and customer-approved purchasing
License-Expression: Apache-2.0
Project-URL: Homepage, https://skipoledata.com/developers
Project-URL: Source, https://github.com/dubbleblack/skipole-connect
Project-URL: Documentation, https://github.com/dubbleblack/skipole-connect/blob/main/HOSTED-PURCHASES.md
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# `skipole-data` Python SDK source

**Do not install the unrelated `skipole` project from PyPI.** Our proposed
distribution name is `skipole-data`; its Python import remains `skipole`.
PyPI ownership/publisher setup is pending. No PyPI publication is claimed.

## Install the published GitHub wheel

Python 3.10+ is required. This is a tested GitHub prerelease, **not a PyPI
release**:

```sh
python -m pip install "https://github.com/dubbleblack/skipole-connect/releases/download/sdk-v0.1.0-alpha.1/skipole_data-0.1.0a1-py3-none-any.whl"
```

The [release page](https://github.com/dubbleblack/skipole-connect/releases/tag/sdk-v0.1.0-alpha.1)
includes SHA256SUMS and a source archive. The Python import remains
`from skipole import SkipoleClient`. Paid Python SDK purchases are independently
unverified.

## Alternatively, install from public source

```sh
python -m pip install "git+https://github.com/dubbleblack/skipole-connect.git#subdirectory=python"
```

Python 3.10+ and Git are required. This uses the existing package build, not an
unrelated registry project. Keep the key server-side and follow the
[customer-approved purchase example](../HOSTED-PURCHASES.md#python).
The paid REST path is Production verified; an independently paid Python SDK
round trip is not.

This is the versioned pre-release Python client for Skipole's documented REST
endpoints. Customer-approved hosted REST purchasing is live. The separate legacy
credit-funded provider operations remain controlled by capability and budget policy.

The public catalog and pricing routes need no API key. Customer catalog, synthetic demo, and usage routes require a customer API key with the relevant scope. Keep that key in server-side secrets and never place it in a browser app.

The client also exposes quote, credit-funded provider request, job status, and CSV export methods. A quote does not call the supplier. These separately gated methods require a valid signed quote, `data:write`, sufficient credits, and an active policy; they are not the one-time customer Checkout flow. The client does not automatically retry paid operations or create Stripe Checkout sessions. Customers buy licensed Marketing Professionals orders and download their CSV through the signed-in website when purchasing is enabled, without a subscription or prepaid credits. Catalog/usage success does not prove paid API availability.

No PyPI release has been made. It is licensed under Apache-2.0; the license file is copied from the integration package root before building. Do not publish this package without explicit release authorization.

## Build and test

From this directory:

```sh
python scripts/prepare-release.py
PYTHONPATH=src python -m unittest discover -s tests
uv build --wheel --no-build-isolation --out-dir /tmp/skipole-wheels
```

```python
from skipole import SkipoleClient

client = SkipoleClient()
products = client.list_products()
print(products)
```
