phisaver-client 1.0.4__tar.gz

phisaver_client-1.0.4/.envrc

@@ -0,0 +1,5 @@
+dotenv ../.env
+source .venv/bin/activate
+# bug fix: https://github.com/direnv/direnv/wiki/PS1
+unset PS1
+

phisaver_client-1.0.4/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

phisaver_client-1.0.4/.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+    "python.testing.pytestArgs": [
+        "test"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+        }
+    },
+    "debugpy.debugJustMyCode": true
+}

phisaver_client-1.0.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Brett Beeson
+
+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.

phisaver_client-1.0.4/Makefile

@@ -0,0 +1,49 @@
+RUN = uv run
+
+help:       ## Show this help.
+		@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+buildtools:  ## Install development dependencies 
+	uv pip install -e ".[dev]"
+
+schema:
+	@echo Run the following command to generate the schema:
+	@echo pushd ../server/
+	@echo make schema
+	@echo popd
+
+
+autogen: FORCE ## Generate the OpenAPI client code
+		$(RUN) openapi-python-client generate --output-path src/ --overwrite --path ../server/schema.yml  --config openapi_python_client.yaml
+
+runserver:   ## Run the django server
+	@echo Run these commands
+	@echo pushd ../server/
+	@echo "make runserver &"
+	@echo popd
+
+clean-dist:  ## Clean build artifacts
+	rm -rf dist/ build/ *.egg-info src/*.egg-info
+
+build: buildtools clean-dist ## Build distribution packages
+	$(RUN) python -m build
+
+test-upload: build ## Upload to Test PyPI (test first!)
+	@echo "Uploading to Test PyPI..."
+	twine upload --repository testpypi dist/*
+	@echo "Test with: pip install --index-url https://test.pypi.org/simple/ phisaver-client"
+
+upload: build ## Upload to PyPI (PRODUCTION)
+	@echo "WARNING: Publishing to PRODUCTION PyPI!"
+	@echo "Version: $$(grep '^version' pyproject.toml | cut -d'"' -f2)"
+	@read -p "Continue? [y/N] " confirm && [ "$$confirm" = "y" ]
+	@echo "Uploading to PyPI..."
+	twine upload dist/*
+	@echo "Published! Install with: pip install phisaver-client"
+
+check-version: ## Show current version
+	@grep '^version' pyproject.toml
+
+FORCE: ## Force the rule to always run
+	@true
+		

phisaver_client-1.0.4/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: phisaver-client
+Version: 1.0.4
+Summary: A client library for accessing Phisaver API
+Project-URL: Homepage, https://github.com/phisaver/phisaver-client
+Project-URL: Repository, https://github.com/phisaver/phisaver-client
+Author-email: Brett Beeson <brett@phisaver.com>
+License: MIT
+License-File: LICENSE
+Keywords: api,client,openapi,phisaver
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: python-dateutil>=2.8.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: openapi-python-client>=0.25.2; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+This package provides a client for the PhiSaver API. It is auto-generated using OpenAPI specifications from that API. 
+
+
+## Install
+
+```bash
+pip install phisaver-client
+```
+
+
+<!-- ## Usage
+```
+import phisaver_client 
+
+For testing from Test PyPI:
+```bash
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ phisaver-client
+```
+
+
+
+``` -->
+
+## Documentation
+
+The documentation for the client can be found at: https://github.com/phisaver/phisaver-client

phisaver_client-1.0.4/README.md

@@ -0,0 +1,26 @@
+This package provides a client for the PhiSaver API. It is auto-generated using OpenAPI specifications from that API. 
+
+
+## Install
+
+```bash
+pip install phisaver-client
+```
+
+
+<!-- ## Usage
+```
+import phisaver_client 
+
+For testing from Test PyPI:
+```bash
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ phisaver-client
+```
+
+
+
+``` -->
+
+## Documentation
+
+The documentation for the client can be found at: https://github.com/phisaver/phisaver-client

phisaver_client-1.0.4/USAGE_EXAMPLES.md

@@ -0,0 +1,178 @@
+# PhiSaver Client Usage Examples
+
+## Authentication
+
+```python
+from phisaver_client import get_client_from_env, get_client
+
+# Option 1: Use environment variables
+# Set PHISAVER_URL, PHISAVER_USERNAME, PHISAVER_PASSWORD
+client = get_client_from_env()
+
+# Option 2: Pass credentials explicitly
+client = get_client(
+    base_url="https://app.phisaver.com",
+    username="your-email@example.com",
+    password="your-password"
+)
+```
+
+## Time Series Data
+
+### Method 1: Dict-like Access (Recommended)
+
+The response models support `__getitem__`, so you can use them like dictionaries:
+
+```python
+from phisaver_client.api.ts import ts_series_retrieve
+
+# Fetch time series data
+result = ts_series_retrieve.sync(
+    client=client,
+    bin_="1h",           # 1-hour bins
+    sites="demo1",       # Device ID
+    start=start_time,
+    stop=end_time,
+)
+
+# Direct dict-like access (NO .additional_properties needed!)
+production_data = result["demo1"]["Production"]
+net_data = result["demo1"]["Net"]
+
+for timestamp, value in production_data:
+    print(f"Production at {timestamp}: {value}W")
+```
+
+### Method 2: Using as_dict() Helper
+
+For explicit conversion to plain dict:
+
+```python
+from phisaver_client import as_dict
+from phisaver_client.api.ts import ts_series_retrieve
+
+result = ts_series_retrieve.sync(
+    client=client,
+    bin_="1h",
+    sites="demo1,demo2",  # Multiple devices
+)
+
+# Convert to plain dict
+data = as_dict(result)
+
+# Iterate over all devices and metrics
+for device_id, metrics in data.items():
+    print(f"Device: {device_id}")
+    for metric_name, timeseries in metrics.items():
+        print(f"  {metric_name}: {len(timeseries)} data points")
+        # Each timeseries is a list of [timestamp, value] pairs
+```
+
+### Method 3: With Type Hints
+
+```python
+from phisaver_client import TimeSeriesData
+from phisaver_client.api.ts import ts_series_retrieve
+
+def process_energy_data(client, site: str) -> TimeSeriesData:
+    """Fetch and return time series data with proper typing"""
+    result = ts_series_retrieve.sync(
+        client=client,
+        bin_="15min",
+        sites=site,
+        attribute="power",
+        units="kW",
+    )
+    
+    # Type hints available for IDE autocomplete
+    data: TimeSeriesData = as_dict(result)
+    return data
+
+# Usage
+data = process_energy_data(client, "demo1")
+production = data["demo1"]["Production"]  # Full IDE support
+```
+
+## Query Parameters
+
+Common parameters for time series queries:
+
+```python
+from datetime import datetime, timedelta
+from phisaver_client.api.ts import ts_series_retrieve
+
+end = datetime.now()
+start = end - timedelta(days=7)
+
+result = ts_series_retrieve.sync(
+    client=client,
+    bin_="1h",                    # Aggregation interval
+    sites="demo1,demo2",          # Comma-separated device IDs
+    start=start,                  # Start time
+    stop=end,                     # End time
+    attribute="power",            # Metric type
+    function="mean",              # Aggregation function
+    units="kW",                   # Units
+    named=True,                   # Use device names instead of IDs
+    timeformat="iso",             # Timestamp format (iso/epoch/epochms)
+)
+```
+
+## Error Handling
+
+```python
+from phisaver_client.api.ts import ts_series_retrieve
+import httpx
+
+try:
+    result = ts_series_retrieve.sync_detailed(  # Use sync_detailed for status code
+        client=client,
+        bin_="1h",
+        sites="demo1",
+    )
+    
+    if result.status_code == 200:
+        data = result.parsed
+        print(f"Success! Got data for {len(data)} devices")
+    else:
+        print(f"Error: {result.status_code}")
+        
+except httpx.TimeoutException:
+    print("Request timed out")
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## Device Management
+
+```python
+from phisaver_client.api.devices import devices_list
+
+# List all devices
+devices = devices_list.sync(client=client)
+
+for device in devices:
+    print(f"{device.ref}: {device.name}")
+```
+
+## Best Practices
+
+1. **Use dict-like access** - No need for `.additional_properties`
+2. **Use `sync_detailed()`** when you need status codes
+3. **Use `sync()`** when you just need the data (returns `None` on error)
+4. **Set proper timeouts** in client construction
+5. **Use type hints** from helpers module for better IDE support
+
+## Common Pitfalls
+
+❌ **Don't do this:**
+```python
+data = result.additional_properties["demo1"]["Production"]
+```
+
+✅ **Do this instead:**
+```python
+data = result["demo1"]["Production"]
+# or
+data = as_dict(result)["demo1"]["Production"]
+```

phisaver_client-1.0.4/openapi_python_client.yaml

@@ -0,0 +1,7 @@
+literal_enums: true
+package_name: openapi_python_client
+output_dir: .
+
+project_name_override: phisaver_client
+package_name_override: phisaver_client
+# output_path is not available, set in cli command

phisaver_client-1.0.4/pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "phisaver-client"
+version = "1.0.4"
+description = "A client library for accessing Phisaver API"
+authors = [{ name = "Brett Beeson", email = "brett@phisaver.com" }]
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+keywords = ["phisaver", "api", "client", "openapi"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "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 :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+    "httpx>=0.28.1",
+    "attrs>=22.2.0",
+    "python-dateutil>=2.8.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/phisaver/phisaver-client"
+Repository = "https://github.com/phisaver/phisaver-client"
+
+
+[project.optional-dependencies]
+dev = [
+    "openapi-python-client>=0.25.2",
+    "pytest>=7.0",
+    "build>=1.0.0",
+    "twine>=5.0.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/phisaver_client"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["F", "I", "UP"]

phisaver_client-1.0.4/src/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

phisaver_client-1.0.4/src/README.md

@@ -0,0 +1,124 @@
+# phisaver_client
+A client library for accessing Phisaver API
+
+## Usage
+First, create a client:
+
+```python
+from phisaver_client import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from phisaver_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from phisaver_client.models import MyDataModel
+from phisaver_client.api.my_tag import get_my_data_model
+from phisaver_client.types import Response
+
+with client as client:
+    my_data: MyDataModel = get_my_data_model.sync(client=client)
+    # or if you need more info (e.g. status_code)
+    response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from phisaver_client.models import MyDataModel
+from phisaver_client.api.my_tag import get_my_data_model
+from phisaver_client.types import Response
+
+async with client as client:
+    my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+    response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken", 
+    verify_ssl=False
+)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `phisaver_client.api.default`
+
+## Advanced customizations
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from phisaver_client import Client
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+client = Client(
+    base_url="https://api.example.com",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from phisaver_client import Client
+
+client = Client(
+    base_url="https://api.example.com",
+)
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))
+```
+
+## Building / publishing this package
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
+1. Update the metadata in pyproject.toml (e.g. authors, version)
+1. If you're using a private repository, configure it with Poetry
+    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
+    1. `poetry config http-basic.<your-repository-name> <username> <password>`
+1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
+1. If that project is not using Poetry:
+    1. Build a wheel with `poetry build -f wheel`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`

phisaver_client-1.0.4/src/phisaver_client/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage