Python wrapper for the Ouro API
Project description
ouro-py
Python client for Ouro
- Documentation: ouro.foundation/docs
Usage
Generate an API key from your account settings by going to ouro.foundation/app/settings/api-keys.
Set your Ouro environment variables in a dotenv file, or using the shell:
export USER_API_KEY="your_ouro_api_key"
Init client:
import os
from ouro import Ouro
api_key = os.environ.get("USER_API_KEY")
ouro = Ouro()
ouro.login(api_key)
Use the client to interface with the Ouro framework.
Create a dataset
data = pd.DataFrame([
{"name": "Bob", "age": 30},
{"name": "Alice", "age": 27},
{"name": "Matt", "age": 26},
])
dataset = ouro.earth.create_dataset({
"name": "unique_dataset_name",
"visibility": "private",
},
data
)
Contributing
Contributing to the Python library is a great way to get involved with the Ouro community. Reach out to us on our Github Discussions page if you want to get involved.
Set up a Local Development Environment
Clone the Repository
git clone git@github.com:ourofoundation/ouro-py.git
cd ouro-py
Create and Activate a Virtual Environment
We recommend activating your virtual environment. Click here for more about Python virtual environments and working with conda and poetry.
Using venv (Python 3 built-in):
python3 -m venv env
source env/bin/activate # On Windows, use .\env\Scripts\activate
Using conda:
conda create --name ouro-py
conda activate ouro-py
PyPi installation
Install the package (for > Python 3.7):
# with pip
pip install ouro
Local installation
You can also install locally after cloning this repo. Install Development mode with pip install -e
, which makes it so when you edit the source code the changes will be reflected in your python module.
Badges
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.