pyoso
WARNING: THIS IS A WORK IN PROGRESS
pyoso is a Python package for fetching models and metrics from OSO. This package provides an easy-to-use interface to interact with oso and retrieve valuable data for analysis and monitoring.
Features
- Execute custom SQL queries for analyzing the OSO dataset.
- Inspect data dependencies and freshness with an analytics tree.
- Semantic modeling layer to build and execute complex queries (optional).
Installation
You can install pyoso using pip:
pip install pyoso
Optional Semantic Modeling
For semantic modeling capabilities, you can install with the semantic extra:
pip install pyoso[semantic]
This will include the oso_semantic package for building semantic models and queries.
Usage
Here is a basic example of how to use pyoso to fetch data directly into a pandas DataFrame:
import os
from pyoso import Client
# Initialize the client with an API key
os.environ["OSO_API_KEY"] = 'your_api_key'
client = Client()
# Fetch artifacts
query = "SELECT * FROM artifacts_v1 LIMIT 5"
artifacts = client.to_pandas(query)
print(artifacts)
Inspecting Data Dependencies
For more advanced use cases, the client.query() method returns a QueryResponse object that contains both the data and analytics metadata. This allows you to inspect the dependency tree of the data sources used in your query.
import os
from pyoso import Client
# Initialize the client
os.environ["OSO_API_KEY"] = "your_api_key"
client = Client()
# Execute a query to get a QueryResponse object
query = "SELECT * FROM artifacts_v1 LIMIT 5"
response = client.query(query)
# You can still get the DataFrame as before
df = response.to_pandas()
print("\n--- Query Data ---")
print(df)
# Now, inspect the analytics to see the dependency tree
print("\n--- Data Dependency Tree ---")
response.analytics.print_tree()
This will output a tree structure showing how the final artifacts_v1 table was constructed from its upstream dependencies, helping you understand the data's origin and freshness.
Documentation
For detailed documentation about the OSO dataset, please refer to the official documentation.
Future Plans
- Create DataFrame wrapper for creating SQL query from data transforms
1 maintainer
Metadata
1 maintainer
Release files for pyoso 0.6.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyoso-0.6.2.tar.gz | 9.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyoso-0.6.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.4 kB
Release files / pyoso-0.6.2.tar.gz
| Download URL | pyoso-0.6.2.tar.gz |
|---|---|
| Size | 9.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
06627a524d53f64d1849048d39f8db2a50344c8d259ea72edc0536be7281f961
|
|
BLAKE2b-256 checksum How to use checksums |
1131d3d44936e76fd1e8d0de50b1ece4d8be4534f6591092f365f0a31310e2ef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.1
|
Release files / pyoso-0.6.2-py3-none-any.whl
| Download URL | pyoso-0.6.2-py3-none-any.whl |
|---|---|
| Size | 7.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
56d54c0f4fbf3e59d69da4d2d5024018826fd795f4d589401237c4ae110fa5ed
|
|
BLAKE2b-256 checksum How to use checksums |
28095014ca2d6ddb35a87b14e3dffaa9f83cbfa5cf3ecfd749195930a70dbcdc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.1
|
