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.2

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.2
File Actions
oxenai-0.67.2-cp311-abi3-win_amd64.whl CPython 3.11 abi3 Windows x86-64 Details for oxenai-0.67.2-cp311-abi3-win_amd64.whl
oxenai-0.67.2-cp311-abi3-manylinux_2_34_x86_64.whl CPython 3.11 abi3 Linux glibc 2.34+ x86-64 Details for oxenai-0.67.2-cp311-abi3-manylinux_2_34_x86_64.whl
oxenai-0.67.2-cp311-abi3-manylinux_2_34_aarch64.whl CPython 3.11 abi3 Linux glibc 2.34+ ARM64 Details for oxenai-0.67.2-cp311-abi3-manylinux_2_34_aarch64.whl
oxenai-0.67.2-cp311-abi3-manylinux_2_28_x86_64.whl CPython 3.11 abi3 Linux glibc 2.28+ x86-64 Details for oxenai-0.67.2-cp311-abi3-manylinux_2_28_x86_64.whl
oxenai-0.67.2-cp311-abi3-manylinux_2_28_aarch64.whl CPython 3.11 abi3 Linux glibc 2.28+ ARM64 Details for oxenai-0.67.2-cp311-abi3-manylinux_2_28_aarch64.whl
oxenai-0.67.2-cp311-abi3-macosx_11_0_arm64.whl CPython 3.11 abi3 macOS 11.0+ ARM64 Details for oxenai-0.67.2-cp311-abi3-macosx_11_0_arm64.whl
oxenai-0.67.2-cp311-abi3-macosx_10_13_x86_64.whl CPython 3.11 abi3 macOS 10.13+ x86-64 Details for oxenai-0.67.2-cp311-abi3-macosx_10_13_x86_64.whl

Total release size: 238.5 MB

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

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

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

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

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

Download URL oxenai-0.67.2-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
b9b7e97b90c097cac89b7455004e01a76cd4a4da14a68c69a6af8b9ea62a066b
BLAKE2b-256 checksum
How to use checksums
c862ca20325c81922b41b9aa52ef6f379b72e229ae018ba98fb45e682eeede54
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

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

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

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

Download URL oxenai-0.67.2-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
3dc21a3765e4e5781404a136727422f1f3f06e1d4b9c21516d171808e0a07ab7
BLAKE2b-256 checksum
How to use checksums
9e55551f5d614cb86b1949d824cef3349e01cbc312251c4f086ff25eba1c9251
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

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

Download URL oxenai-0.67.2-cp311-abi3-macosx_11_0_arm64.whl
Size 32.6 MB
Tags CPython 3.11 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
6ae361138cda205a1470b15bbd7e00bee62c4ad48b73427a60dcdd823a54833e
BLAKE2b-256 checksum
How to use checksums
447e54295a1525a1067288050a5ad3cf4e2f9770f95a7d968d745d4663abaee4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

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

Download URL oxenai-0.67.2-cp311-abi3-macosx_10_13_x86_64.whl
Size 35.5 MB
Tags CPython 3.11 abi3 macOS 10.13+ x86-64
SHA-256 checksum
How to use checksums
3f04f61ea42d8f448448069a45df86610a4605d623c6ac06165f9e95210bc899
BLAKE2b-256 checksum
How to use checksums
6258e129a2418c1395eb13bebe4afe37dfea2824a4f2cc7040f2073cc0aae38d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via maturin/1.8.4

Security for oxenai 0.67.2

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.2 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