​

oxen.remote_repo

​

get_repo

def get_repo(name: str, host: str = "hub.oxen.ai", scheme: str = "https")

• name - str Name of the repository in the format ‘namespace/repo_name’.
• host - str The host to connect to. Defaults to ‘hub.oxen.ai’

​

create_repo

def create_repo(name: str,
                description="",
                is_public: bool = True,
                host: str = "hub.oxen.ai",
                scheme: str = "https",
                files: List[Tuple[str, str]] = [])

• name - str Name of the repository in the format ‘namespace/repo_name’.
• description - str Description of the repository. Only applicable to OxenHub.
• is_public - bool Whether the repository is public or private. Only applicable to OxenHub.
• host - str The host to connect to. Defaults to ‘hub.oxen.ai’
• scheme - str The scheme to use for the remote url. Default: ‘https’
• files - List[Tuple[str, str]] A list of tuples containing the path to the file and the contents of the file that you would like to seed the repository with.

​

RemoteRepo Objects

class RemoteRepo()

​

Examples

​

Add & Commit Files

from oxen import RemoteRepo

repo = RemoteRepo("ox/CatDogBBox")
repo.add("/path/to/image.png")
status = repo.status()
print(status.added_files())
repo.commit("Adding my image to the remote workspace.")

​

Downloading Specific Files

from oxen import RemoteRepo
import pandas as pd

# Connect to the remote repo
repo = RemoteRepo("ox/CatDogBBox")
# Specify the version of the file you want to download
branch = repo.get_branch("my-pets")
# Download takes a file or directory a commit id
repo.download("annotations", revision=branch.commit_id)
# Once you have the data locally, use whatever library you want to explore the data
df = pd.read_csv("annotations/train.csv")
print(df.head())

​

__init__

def __init__(repo_id: str,
             host: str = "hub.oxen.ai",
             revision: str = "main",
             scheme: str = "https")

• repo_id - str Name of the repository in the format ‘namespace/repo_name’. For example ‘ox/chatbot’
• host - str The host to connect to. Defaults to ‘hub.oxen.ai’
• revision - str The branch name or commit id to checkout. Defaults to ‘main’
• scheme - str The scheme to use for the remote url. Default: ‘https’

​

create

def create(empty: bool = False, is_public: bool = False)

• empty - bool Whether to create an empty repo or not. Default: False
• is_public - bool Whether the repository is public or private. Default: False

​

exists

def exists() -> bool

​

delete

def delete()

​

checkout

def checkout(revision: str, create=False)

• revision - str The name of the branch or commit id to checkout.
• create - bool Whether to create a new branch if it doesn’t exist. Default: False

​

ls

def ls(directory: Optional[str] = None,
       page_num: int = 1,
       page_size: int = 100)

• directory - str The directory to list. If None, will list the root directory.
• page_num - int The page number to return. Default: 1
• page_size - int The number of items to return per page. Default: 100

​

scan

def scan(directory: Optional[str] = None, page_size: int = 100)

• directory - str The directory to list. If None, will list the root directory
• page_size - int The number of items to return per page. Default: 100

​

download

def download(src: str,
             dst: Optional[str] = None,
             revision: Optional[str] = None)

• src - str The path to the remote file
• dst - str | None The path to the local file. If None, will download to the same path as src
• revision - str | None The branch or commit id to download. Defaults to self.revision

​

add

def add(src: str,
        dst: Optional[str] = "",
        branch: Optional[str] = None,
        workspace_name: Optional[str] = None)

• src - str The path to the local file to upload
• dst - str | None The directory to upload the file to. If None, will upload to the root directory.
• branch - str | None The branch to upload the file to. Defaults to self.revision

​

status

def status()

​

commit

def commit(message: str)

​

upload

def upload(src: str,
           commit_message: str,
           file_name: Optional[str] = None,
           dst_dir: Optional[str] = "",
           branch: Optional[str] = None)

• src - str The path to the local file to upload
• file_name - str | None The name of the file to upload. If None, will use the name of the file in src
• dst_dir - str | None The directory to upload the file to. If None, will upload to the root directory.
• branch - str | None The branch to upload the file to. Defaults to self.revision

​

metadata

def metadata(path: str)

​

file_exists

def file_exists(path: str, revision: str = None)

• path - str The path to the file to check
• revision - str The revision to check against, defaults to self.revision

​

file_has_changes

def file_has_changes(local_path: str,
                     remote_path: str = None,
                     revision: str = None)

• local_path - str The local path to the file to check
• remote_path - str The remote path to the file to check, will default to local_path if not provided
• revision - str The revision to check against, defaults to self.revision

​

log

def log()

​

branch_exists

def branch_exists(name: str) -> bool

• name - str The name of the branch to check

​

branch

def branch()

​

branches

def branches()

​

list_workspaces

def list_workspaces()

​

get_branch

def get_branch(branch: str)

• branch - str The name of the branch to return

​

create_branch

def create_branch(branch: str)

• branch - str The name to assign to the created branch

​

create_checkout_branch

def create_checkout_branch(branch: str)

• branch - str The name to assign to the created branch

​

merge

def merge(base_branch: str, head_branch: str)

• base_branch - str The base branch to merge into
• head_branch - str The head branch to merge

​

namespace

@property
def namespace() -> str

​

name

@property
def name() -> str

​

identifier

@property
def identifier()

​

url

@property
def url() -> str

​

revision

@property
def revision() -> str