Skip to main content

🐂 🐍 Oxen Python Interface

The Oxen python interface makes it easy to integrate Oxen datasets directly into machine learning dataloaders or other data pipelines.

Repositories

There are two types of repositories one can interact with, a Repo and a RemoteRepo.

Local Repo

To fully clone all the data to your local machine, you can use the Repo class.

import oxen

repo = oxen.Repo("path/to/repository")
repo.clone("https://hub.oxen.ai/ox/CatDogBBox")

If there is a specific version of your data you want to access, you can specify the branch when cloning.

repo.clone("https://hub.oxen.ai/ox/CatDogBBox", branch="my-pets")

Once you have a repository locally, you can perform the same operations you might via the command line, through the python api.

For example, you can checkout a branch, add a file, commit, and push the data to the same remote you cloned it from.

import oxen

repo = oxen.Repo("path/to/repository")
repo.clone("https://hub.oxen.ai/ox/CatDogBBox")
repo.checkout()

Remote Repo

If you don't want to download the data locally, you can use the RemoteRepo class to interact with a remote repository on OxenHub.

import oxen

repo = oxen.RemoteRepo("https://hub.oxen.ai/ox/CatDogBBox")

To stage and commit files to a specific version of the data, you can checkout an existing branch or create a new one.

repo.create_branch("dev")
repo.checkout("dev")

You can then stage files to the remote repository by specifying the file path and destination directory.

repo.add("new-cat.png", "images") # Stage to images/new-cat.png on remote
repo.commit("Adding another training image")

Note that no "push" command is required here, since the above code creates a commit directly on the remote branch.

Build 🔨

See the prerequisites section of the main readme before developing.

To get and build dependencies, as well as the oxen-python code, run:

uv sync --verbose

To build the PyO3 oxen wrappers only, use maturin and --no-sync:

uv run --no-sync maturin develop

Test

Run pytest:

uv run --verbose pytest -s tests/

If you have already installed all dependencies, and you're not making any changes to liboxen, then you may use --no-sync:

uv run --no-sync pytest -s tests/

Format and lint code with:

uvx ruff check .
uvx ruff format .

Logging

Oxen uses structured logging. It outputs to STDERR by default but can be configured with rotating log files. See Logging for details.

By default, the oxen-python does not perform any logging. Set RUST_LOG to change.

Metadata

Release files for oxenai 0.67.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for oxenai 0.67.3
File Actions
oxenai-0.67.3-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details for oxenai-0.67.3-cp311-abi3-win_amd64.whl
oxenai-0.67.3-cp311-abi3-manylinux_2_34_x86_64.whl CPython 3.11 abi3 Linux glibc 2.34+ x86-64 Details for oxenai-0.67.3-cp311-abi3-manylinux_2_34_x86_64.whl
oxenai-0.67.3-cp311-abi3-manylinux_2_34_aarch64.whl CPython 3.11 abi3 Linux glibc 2.34+ ARM64 Details for oxenai-0.67.3-cp311-abi3-manylinux_2_34_aarch64.whl
oxenai-0.67.3-cp311-abi3-manylinux_2_28_x86_64.whl CPython 3.11 abi3 Linux glibc 2.28+ x86-64 Details for oxenai-0.67.3-cp311-abi3-manylinux_2_28_x86_64.whl
oxenai-0.67.3-cp311-abi3-manylinux_2_28_aarch64.whl CPython 3.11 abi3 Linux glibc 2.28+ ARM64 Details for oxenai-0.67.3-cp311-abi3-manylinux_2_28_aarch64.whl
oxenai-0.67.3-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details for oxenai-0.67.3-cp311-abi3-macosx_11_0_arm64.whl
oxenai-0.67.3-cp311-abi3-macosx_10_13_x86_64.whl CPython 3.11 abi3 macOS 10.13+ x86-64 Details for oxenai-0.67.3-cp311-abi3-macosx_10_13_x86_64.whl

Total release size: 239.2 MB

Release files / oxenai-0.67.3-cp311-abi3-win_amd64.whl

Download URL oxenai-0.67.3-cp311-abi3-win_amd64.whl
Size 34.9 MB
Tags CPython 3.11 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
2b85380333eecd4e1125b5b809610daba3e186ee5ed7b6af3c7ca764b51a5754
BLAKE2b-256 checksum
How to use checksums
69a0dbbd0aae7fa05d8d70ca04e6a4642bc720cce81f4cbab4ae59e48e9b214a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

Release files / oxenai-0.67.3-cp311-abi3-manylinux_2_34_x86_64.whl

Download URL oxenai-0.67.3-cp311-abi3-manylinux_2_34_x86_64.whl
Size 34.8 MB
Tags CPython 3.11 Linux glibc 2.34+ x86-64 abi3
SHA-256 checksum
How to use checksums
699390ac3bd5db4e357ea5474a38c84c85289b54d8ad55a9d7ef9c2b7f997e82
BLAKE2b-256 checksum
How to use checksums
b7c9f487eeff267a6adc1873bbeabac8adcd4eefb9dc9007a9525487fd55b1be
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

Release files / oxenai-0.67.3-cp311-abi3-manylinux_2_34_aarch64.whl

Download URL oxenai-0.67.3-cp311-abi3-manylinux_2_34_aarch64.whl
Size 33.0 MB
Tags CPython 3.11 Linux glibc 2.34+ ARM64 abi3
SHA-256 checksum
How to use checksums
7315a3103317ffb0abf673276938addfd9d40bd413fea4d3e492accd3affb52d
BLAKE2b-256 checksum
How to use checksums
0ec90495aca6984b2b63a6404037ef6ee062dcc8b5aa66b5309a3d0c5b662e64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

Release files / oxenai-0.67.3-cp311-abi3-manylinux_2_28_x86_64.whl

Download URL oxenai-0.67.3-cp311-abi3-manylinux_2_28_x86_64.whl
Size 35.1 MB
Tags CPython 3.11 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
5009a13dd2008392fad2ac00f9aa40858ef880e06425f727e4a3abadab9782c5
BLAKE2b-256 checksum
How to use checksums
fa25b3a2bde1f82774d71f075125ef0201b7b4555a4275193bbf0d7a99dbc20d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

Release files / oxenai-0.67.3-cp311-abi3-manylinux_2_28_aarch64.whl

Download URL oxenai-0.67.3-cp311-abi3-manylinux_2_28_aarch64.whl
Size 33.2 MB
Tags CPython 3.11 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
399c517edcb705408e632c5211a7e47888b37232976c2a639e0295571e3742d8
BLAKE2b-256 checksum
How to use checksums
62362a4e64113fddd65cde071d80473760fe51dc900cc91f48b4f10d8a88a386
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

Release files / oxenai-0.67.3-cp311-abi3-macosx_11_0_arm64.whl

Download URL oxenai-0.67.3-cp311-abi3-macosx_11_0_arm64.whl
Size 32.7 MB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
65fc8494176f6d3d19259dc4872bc57b492beb8b86f94ff6498db828dae2c16a
BLAKE2b-256 checksum
How to use checksums
1fc4e300b033d0db5dc9292dcf02a9dbe9b3e87f1b9b1aeb23e819af3041e78f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

Release files / oxenai-0.67.3-cp311-abi3-macosx_10_13_x86_64.whl

Download URL oxenai-0.67.3-cp311-abi3-macosx_10_13_x86_64.whl
Size 35.6 MB
Tags CPython 3.11 abi3 macOS 10.13+ x86-64
SHA-256 checksum
How to use checksums
e0829dc837eb78c71b2e87e62f7ac199f00cd28eca3818ec395e087116b1f3e3
BLAKE2b-256 checksum
How to use checksums
73dc2d4580e3f4cab22e4ec10257fbf04089f1254a09e6d2c56c1ab0fc339ab5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

Security for oxenai 0.67.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.67.3 This release

7 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page