oxenai 0.36.3__cp312-cp312-manylinux_2_34_aarch64.whl → 0.36.5__cp312-cp312-manylinux_2_34_aarch64.whl

oxenai-0.36.5.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: oxenai
+Version: 0.36.5
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Version Control
+Requires-Dist: fsspec>=2025.7.0
+Requires-Dist: maturin>=1.9.3
+Requires-Dist: pandas>=2.3.1
+Requires-Dist: polars>=1.32.0
+Requires-Dist: pyarrow>=21.0.0
+Requires-Dist: pytest>=8.4.1
+Requires-Dist: pytest-datadir>=1.8.0
+Requires-Dist: requests>=2.32.4
+Requires-Dist: ruff>=0.12.7
+Requires-Dist: toml>=0.10.2
+Requires-Dist: tqdm>=4.67.1
+Summary: Data version control for machine learning
+Keywords: oxen,version control
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://www.oxen.ai/
+Project-URL: Documentation, https://docs.oxen.ai/
+Project-URL: Repository, https://github.com/Oxen-AI/Oxen
+
+# 🐂 🐍 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.
+
+

{oxenai-0.36.3.dist-info → oxenai-0.36.5.dist-info}/RECORD

@@ -17,7 +17,7 @@ oxen/features.py,sha256=5zLscxbX_4OcpjqZz2mkj5obX-6AMyMNCXASJzo_qx4,1378
 oxen/fs.py,sha256=yfDX7jcIUUXAzfoj67znKoPNGUS8C0tWAOczEnSQAKI,1485
 oxen/init.py,sha256=OLNE_EaIpJuX5Z7oTot_k7gPQJpCqyVqRtNg1WqCQ3w,398
 oxen/notebooks.py,sha256=zRxAmFHkWWGtspcD3EZ0-QCihiRh-WSwYyKJc2bFWqk,2895
-oxen/oxen.cpython-312-aarch64-linux-gnu.so,sha256=913Us3NWsbxJBo2wGDovUzgYvtKiBvYG8FwTBQRanrw,110313497
+oxen/oxen.cpython-312-aarch64-linux-gnu.so,sha256=bjtBhXe6t4iR3OTa4selyR-IdklTggqPbRBpZRo28Fw,122503417
 oxen/oxen_fs.py,sha256=bk3BQy9KPOFIg87T-0pFmXpvR67K9TmU6BVdoD2ULhk,11095
 oxen/providers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 oxen/providers/dataset_path_provider.py,sha256=3hrzA2mGROIgY4et2HB5sSmZyyGdkHsy-uLwzTs9KIw,674
@@ -29,7 +29,7 @@ oxen/streaming_dataset.py,sha256=vHCZ6LuLMwKKHtySbPaekTj1xDJ5NeuXzMB_sjXtIeg,797
 oxen/user.py,sha256=4KeGuoywCneA-ocTyqv-Da1Ho2W1xcdPlHB8h7Rt1HY,1165
 oxen/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 oxen/workspace.py,sha256=jWM7_o8jgMav_xTTa-tCl0aSCXpT7nx2a3eZ4pJmUVQ,5541
-oxenai-0.36.3.dist-info/METADATA,sha256=Yrn39Zo5Qv7vcShYN0Y0StQgQsElHbvyHaFZKcykBdo,460
-oxenai-0.36.3.dist-info/WHEEL,sha256=bFvCrDYfhSwy-9jlWDbD0Nc9KY7zTly2GxupejOGI4s,109
-oxenai-0.36.3.dist-info/entry_points.txt,sha256=CvslGiUZsEt-5k6cJ19pRFHGicXb4XrR0CKhrzq1aEU,40
-oxenai-0.36.3.dist-info/RECORD,,
+oxenai-0.36.5.dist-info/METADATA,sha256=4lJHRKAYia1KU1-2t2JLJNgNnYp3h29Fto9GS2WW2yc,2816
+oxenai-0.36.5.dist-info/WHEEL,sha256=RY1uEu12ByGi2hG5RIBz8vspj4cYEvk_Z24zbYezdP8,109
+oxenai-0.36.5.dist-info/entry_points.txt,sha256=CvslGiUZsEt-5k6cJ19pRFHGicXb4XrR0CKhrzq1aEU,40
+oxenai-0.36.5.dist-info/RECORD,,

{oxenai-0.36.3.dist-info → oxenai-0.36.5.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.9.2)
+Generator: maturin (1.9.3)
 Root-Is-Purelib: false
 Tag: cp312-cp312-manylinux_2_34_aarch64

oxenai-0.36.3.dist-info/METADATA

@@ -1,15 +0,0 @@
-Metadata-Version: 2.4
-Name: oxenai
-Version: 0.36.3
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Dist: fsspec
-Requires-Dist: pandas
-Requires-Dist: polars
-Requires-Dist: pyarrow
-Requires-Dist: requests
-Requires-Dist: toml
-Requires-Dist: tqdm
-Summary: Data version control for machine learning
-Requires-Python: >=3.7