| Name | oxenai JSON |
| Version |
0.36.5
JSON |
| download |
| home_page | None |
| Summary | Data version control for machine learning |
| upload_time | 2025-08-20 02:32:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
oxen
version control
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🐂 🐍 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.
```python
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.
```python
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.
```python
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.
```python
import oxen
repo = 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.
```python
repo.create_branch("dev")
repo.checkout("dev")
```
You can then stage files to the remote repository by specifying the file path and destination directory.
```python
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "oxenai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "oxen, version control",
"author": null,
"author_email": null,
"download_url": null,
"platform": null,
"description": "# \ud83d\udc02 \ud83d\udc0d Oxen Python Interface \n\nThe Oxen python interface makes it easy to integrate Oxen datasets directly into machine learning dataloaders or other data pipelines.\n\n## Repositories\n\nThere are two types of repositories one can interact with, a `Repo` and a `RemoteRepo`.\n\n\n## Local Repo\n\nTo fully clone all the data to your local machine, you can use the `Repo` class.\n\n```python\nimport oxen\n\nrepo = oxen.Repo(\"path/to/repository\")\nrepo.clone(\"https://hub.oxen.ai/ox/CatDogBBox\")\n```\n\nIf there is a specific version of your data you want to access, you can specify the `branch` when cloning.\n\n```python\nrepo.clone(\"https://hub.oxen.ai/ox/CatDogBBox\", branch=\"my-pets\")\n```\n\nOnce you have a repository locally, you can perform the same operations you might via the command line, through the python api.\n\nFor example, you can checkout a branch, add a file, commit, and push the data to the same remote you cloned it from.\n\n```python\nimport oxen\n\nrepo = oxen.Repo(\"path/to/repository\")\nrepo.clone(\"https://hub.oxen.ai/ox/CatDogBBox\")\nrepo.checkout()\n```\n\n## Remote Repo\n\nIf you don't want to download the data locally, you can use the `RemoteRepo` class to interact with a remote repository on OxenHub.\n\n```python\nimport oxen \n\nrepo = RemoteRepo(\"https://hub.oxen.ai/ox/CatDogBBox\")\n```\n\nTo stage and commit files to a specific version of the data, you can `checkout` an existing branch or create a new one.\n\n```python\nrepo.create_branch(\"dev\")\nrepo.checkout(\"dev\")\n```\n\nYou can then stage files to the remote repository by specifying the file path and destination directory.\n\n```python\nrepo.add(\"new-cat.png\", \"images\") # Stage to images/new-cat.png on remote\nrepo.commit(\"Adding another training image\")\n```\n\nNote that no \"push\" command is required here, since the above code creates a commit directly on the remote branch.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Data version control for machine learning",
"version": "0.36.5",
"project_urls": {
"Documentation": "https://docs.oxen.ai/",
"Homepage": "https://www.oxen.ai/",
"Repository": "https://github.com/Oxen-AI/Oxen"
},
"split_keywords": [
"oxen",
" version control"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ed83057d0b47e300f784320543f33e4b7e529e219195e2c0a0fedc7c26d716b7",
"md5": "c119695bd5fa33d9fda9a9629a0604df",
"sha256": "89fd6ed0e18cd6e1d8180e211055ab11229b190fefa10d2d1e989b570e5e7ef2"
},
"downloads": -1,
"filename": "oxenai-0.36.5-cp310-cp310-macosx_10_13_x86_64.whl",
"has_sig": false,
"md5_digest": "c119695bd5fa33d9fda9a9629a0604df",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 40405281,
"upload_time": "2025-08-20T02:32:43",
"upload_time_iso_8601": "2025-08-20T02:32:43.662012Z",
"url": "https://files.pythonhosted.org/packages/ed/83/057d0b47e300f784320543f33e4b7e529e219195e2c0a0fedc7c26d716b7/oxenai-0.36.5-cp310-cp310-macosx_10_13_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4a9f7c08f64d2b58c7c2c65bb69db675857fe0495af4a248b211d52966bddefa",
"md5": "4daa72a3b43d0e4c7ea16799558fc6a7",
"sha256": "dd89ca339098337675279cb5c5fff54b2aa668faa682416de0e20f1edacdc2da"
},
"downloads": -1,
"filename": "oxenai-0.36.5-cp310-cp310-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "4daa72a3b43d0e4c7ea16799558fc6a7",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 36831391,
"upload_time": "2025-08-20T02:32:46",
"upload_time_iso_8601": "2025-08-20T02:32:46.987773Z",
"url": "https://files.pythonhosted.org/packages/4a/9f/7c08f64d2b58c7c2c65bb69db675857fe0495af4a248b211d52966bddefa/oxenai-0.36.5-cp310-cp310-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "16b5818f00f58f04fcafe8bcbbc84f381abd4371fe99ed4beda92552490c69c8",
"md5": "7f5623dff63589747a744ab81f458681",
"sha256": "06249d552bba797dd635d9415c5c05ae9d5c1f568c3044855dbda865e6e63f5a"
},
"downloads": -1,
"filename": "oxenai-0.36.5-cp310-cp310-manylinux_2_34_aarch64.whl",
"has_sig": false,
"md5_digest": "7f5623dff63589747a744ab81f458681",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 41760463,
"upload_time": "2025-08-20T02:32:50",
"upload_time_iso_8601": "2025-08-20T02:32:50.424004Z",
"url": "https://files.pythonhosted.org/packages/16/b5/818f00f58f04fcafe8bcbbc84f381abd4371fe99ed4beda92552490c69c8/oxenai-0.36.5-cp310-cp310-manylinux_2_34_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "440165f6a0c243aa9be5acb938bde2c1c86555ba51a657f6254b8b9a4c4634f0",
"md5": "d9c8bf4928b0702b39e257029750442d",
"sha256": "a57f271ed62006d652d43339aa411d3fd8f93ceb284f9a54599a4b9189b32900"
},
"downloads": -1,
"filename": "oxenai-0.36.5-cp310-cp310-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "d9c8bf4928b0702b39e257029750442d",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 44748069,
"upload_time": "2025-08-20T02:32:53",
"upload_time_iso_8601": "2025-08-20T02:32:53.544620Z",
"url": "https://files.pythonhosted.org/packages/44/01/65f6a0c243aa9be5acb938bde2c1c86555ba51a657f6254b8b9a4c4634f0/oxenai-0.36.5-cp310-cp310-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "07dd6b264217ca808326d4d7fdffc742c8c8026a4e8020096e73fc53ddb7aa0e",
"md5": "35c41bd7e26504e9c3f22063baf46df0",
"sha256": "2ce08f7d28f93b8700181a49cb231f1d7a6dc39d15befde85b985dbbd2eb159e"
},
"downloads": -1,
"filename": "oxenai-0.36.5-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "35c41bd7e26504e9c3f22063baf46df0",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10",
"size": 36953221,
"upload_time": "2025-08-20T02:32:58",
"upload_time_iso_8601": "2025-08-20T02:32:58.613895Z",
"url": "https://files.pythonhosted.org/packages/07/dd/6b264217ca808326d4d7fdffc742c8c8026a4e8020096e73fc53ddb7aa0e/oxenai-0.36.5-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f3a9f88a0915aece8b81406978e21283de4d8cc49324fc76e9ef4cfd5188ded4",
"md5": "75403c5f39d453f41493cefc2aa70a55",
"sha256": "c51c77d14037ae04afabe6e5e28fea3e9c022b8bb091c85dc9a0b713a30d1dd3"
},
"downloads": -1,
"filename": "oxenai-0.36.5-cp311-cp311-macosx_10_13_x86_64.whl",
"has_sig": false,
"md5_digest": "75403c5f39d453f41493cefc2aa70a55",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.10",
"size": 40404177,
"upload_time": "2025-08-20T02:33:02",
"upload_time_iso_8601": "2025-08-20T02:33:02.423765Z",
"url": "https://files.pythonhosted.org/packages/f3/a9/f88a0915aece8b81406978e21283de4d8cc49324fc76e9ef4cfd5188ded4/oxenai-0.36.5-cp311-cp311-macosx_10_13_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "16b8bbfbc0f6c7567c5a51f39bfe809156b085b62d1a7d1ae4e491f0dba91065",
"md5": "f20b73dbaaa8242ab59e8f7ec2649492",
"sha256": "1e75e3b2df8428a84a1073e3809517d00821186723ef48cce810b6284a93c58b"
},
"downloads": -1,
"filename": "oxenai-0.36.5-cp311-cp311-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "f20b73dbaaa8242ab59e8f7ec2649492",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.10",
"size": 36831623,
"upload_time": "2025-08-20T02:33:05",
"upload_time_iso_8601": "2025-08-20T02:33:05.406759Z",
"url": "https://files.pythonhosted.org/packages/16/b8/bbfbc0f6c7567c5a51f39bfe809156b085b62d1a7d1ae4e491f0dba91065/oxenai-0.36.5-cp311-cp311-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5812e964416acf175ae62487d05547e0a110a745f1daf0b32a6dcdf093cae925",
"md5": "96c3b325a1fcbaf2478020bedf194caa",
"sha256": "80de1ee77421219f41ff3411f48e1e6963ddad2dd474f72c0172efdfd747e152"
},
"downloads": -1,
"filename": "oxenai-0.36.5-cp311-cp311-manylinux_2_34_aarch64.whl",
"has_sig": false,
"md5_digest": "96c3b325a1fcbaf2478020bedf194caa",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.10",
"size": 41768409,
"upload_time": "2025-08-20T02:33:08",
"upload_time_iso_8601": "2025-08-20T02:33:08.541320Z",
"url": "https://files.pythonhosted.org/packages/58/12/e964416acf175ae62487d05547e0a110a745f1daf0b32a6dcdf093cae925/oxenai-0.36.5-cp311-cp311-manylinux_2_34_aarch64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-20 02:32:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Oxen-AI",
"github_project": "Oxen",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "oxenai"
}
