unitlab 2.3.48__tar.gz → 2.4.0__tar.gz

unitlab-2.4.0/.claude/settings.local.json

@@ -0,0 +1,38 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(pip install:*)",
+      "Bash(unitlab configure:*)",
+      "Bash(python -m build:*)",
+      "Bash(twine upload:*)",
+      "Bash(git log:*)",
+      "Bash(make fmt:*)",
+      "Bash(make lint:*)",
+      "Bash(make test:*)",
+      "Bash(twine check:*)",
+      "Bash(unitlab project upload:*)",
+      "Bash(unitlab dataset download:*)",
+      "Bash(unitlab project members:*)",
+      "Bash(unitlab dataset list:*)",
+      "Bash(make check:*)",
+      "Bash(sudo add-apt-repository:*)",
+      "Bash(uv python install:*)",
+      "Bash(uv run:*)",
+      "Bash(for ver in 3.10 3.11 3.12 3.13)",
+      "Bash(do echo \"=== Python $ver ===\")",
+      "Bash(unitlab --help:*)",
+      "Bash(unitlab project --help:*)",
+      "Bash(unitlab dataset --help:*)",
+      "Bash(uv pip install:*)",
+      "Bash(UNITLAB_API_KEY=test-key python:*)",
+      "Bash(pip show:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git branch:*)",
+      "Bash(git reset:*)",
+      "Bash(git rm:*)",
+      "Bash(git status:*)",
+      "Bash(git push:*)"
+    ]
+  }
+}

unitlab-2.4.0/.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+Pipfile
+Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+.vscode/
+
+# Downloaded artifacts
+*.zip

unitlab-2.4.0/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: unitlab
+Version: 2.4.0
+Summary: Python SDK for the Unitlab.ai data annotation platform
+Project-URL: Homepage, https://unitlab.ai
+Project-URL: Documentation, https://docs.unitlab.ai
+Project-URL: Repository, https://github.com/teamunitlab/unitlab-sdk
+Author-email: "Unitlab Inc." <team@unitlab.ai>
+License-Expression: MIT
+License-File: LICENSE.md
+Keywords: annotation,data-labeling,machine-learning,sdk,unitlab
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: aiofiles>=23.0
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: requests>=2.28
+Requires-Dist: tqdm>=4.60
+Requires-Dist: typer>=0.9
+Requires-Dist: validators>=0.20
+Provides-Extra: dev
+Requires-Dist: aioresponses>=0.7; extra == 'dev'
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: responses>=0.23; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: twine>=5.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<p align="center">
+    <br>
+        <img src="assets/logo.png" width="400"/>
+    <br>
+<p>
+
+<p align="center">
+    <a href="https://pypi.org/project/unitlab/">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/unitlab">
+    </a>
+    <a href="https://pypi.org/project/unitlab/">
+        <img alt="Python" src="https://img.shields.io/pypi/pyversions/unitlab">
+    </a>
+    <a href="https://github.com/teamunitlab/unitlab-sdk">
+        <img alt="Downloads" src="https://img.shields.io/pypi/dm/unitlab">
+    </a>
+    <a href="https://github.com/teamunitlab/unitlab-sdk/blob/main/LICENSE.md">
+        <img alt="License" src="https://img.shields.io/pypi/l/unitlab">
+    </a>
+</p>
+
+[Unitlab.ai](https://unitlab.ai/) is an AI-driven data annotation platform that automates the collection of raw data, facilitating collaboration with human annotators to produce highly accurate labels for your machine learning models. With our service, you can optimize work efficiency, improve data quality, and reduce costs.
+
+![](assets/unitlabDoc.png)
+
+# Unitlab Python SDK
+
+Python SDK and CLI for the [Unitlab.ai](https://unitlab.ai/) data annotation platform. Manage projects, upload data, and download datasets programmatically or from the command line.
+
+## Installation
+
+```bash
+pip install --upgrade unitlab
+```
+
+Requires Python 3.10+.
+
+## Configuration
+
+Get your API key from [unitlab.ai](https://unitlab.ai/) and configure the CLI:
+
+```bash
+# Set API key
+unitlab configure --api-key YOUR_API_KEY
+
+# Set a custom API URL
+unitlab configure --api-url https://api.unitlab.ai
+
+# Set both at once
+unitlab configure --api-key YOUR_API_KEY --api-url https://api.unitlab.ai
+```
+
+Or set environment variables:
+
+```bash
+export UNITLAB_API_KEY=YOUR_API_KEY
+
+# Optional: point to a custom API server (e.g. self-hosted)
+export UNITLAB_API_URL=https://api.unitlab.ai
+```
+
+## Python SDK
+
+```python
+from unitlab import UnitlabClient
+
+# Initialize with an explicit key
+client = UnitlabClient(api_key="YOUR_API_KEY")
+
+# Or read from UNITLAB_API_KEY env var / config file
+client = UnitlabClient()
+```
+
+The client can also be used as a context manager:
+
+```python
+with UnitlabClient() as client:
+    projects = client.projects()
+```
+
+### Projects
+
+```python
+# List all projects
+projects = client.projects()
+
+# Get project details
+project = client.project("PROJECT_ID")
+
+# Get project members
+members = client.project_members("PROJECT_ID")
+```
+
+### Upload data
+
+```python
+client.project_upload_data(
+    project_id="PROJECT_ID",
+    directory="./images",
+)
+```
+
+Additional options for specific project types:
+
+```python
+# Text projects
+client.project_upload_data("PROJECT_ID", "./docs", sentences_per_chunk=10)
+
+# Video projects
+client.project_upload_data("PROJECT_ID", "./videos", fps=30.0)
+```
+
+### Datasets
+
+```python
+# List all datasets
+datasets = client.datasets()
+
+# Download annotations (COCO, YOLOv8, YOLOv5, etc.)
+path = client.dataset_download("DATASET_ID", export_type="COCO", split_type="train")
+
+# Download raw files
+folder = client.dataset_download_files("DATASET_ID")
+```
+
+## CLI
+
+### Projects
+
+```bash
+# List projects
+unitlab project list
+
+# Project details
+unitlab project detail PROJECT_ID
+
+# Project members
+unitlab project members PROJECT_ID
+
+# Upload data to a project
+unitlab project upload PROJECT_ID --directory ./images
+```
+
+### Datasets
+
+```bash
+# List datasets
+unitlab dataset list
+
+# Download annotations
+unitlab dataset download DATASET_ID --export-type COCO --split-type train
+
+# Download raw files
+unitlab dataset download DATASET_ID --download-type files
+```
+
+
+## Documentation
+
+See the [full documentation](https://docs.unitlab.ai/) for detailed guides:
+
+- [CLI reference](https://docs.unitlab.ai/cli-python-sdk/unitlab-cli)
+- [Python SDK quickstart](https://docs.unitlab.ai/cli-python-sdk/unitlab-python-sdk)
+
+## License
+
+[MIT](LICENSE.md)

unitlab-2.4.0/QUICKSTART.MD

@@ -0,0 +1,24 @@
+First install the Unitlab.ai Python SDK using pip:
+    pip install --upgrade unitlab
+
+Import the necessary packages, and initialize the Unitlab client using your API key:
+    from unitlab import UnitlabClient
+
+    #An API key can be created https://app.unitlab.ai/UnitlabAI/api-keys.
+    api_key = "YOUR API KEY"
+    client = UnitlabClient(api_key)
+
+
+Let's get a list of your projects programmatically using client.projects().
+Note that this list will be retrieved under the user account corresponding to the API key.
+#Result:
+    [{'pk': '0ed69772-fd28-471b-b91c-2a57368c0dfb', 'name': '', 'parent_name': None, 'invoice': {'price': '0.00', 'images': 0}, 'annotator_progress': 0.0, 'reviewer_progress': 0.0, 'creator': 'user@gmail.com', 'created': '2023-04-11T11:00:23.737326+05:00'}, {'pk': '34738aec-b69b-4d30-9763-653017a68c02', 'name': 'human', 'parent_name': 'Red Blood Cell', 'invoice': {'price': '100.00', 'images': 1}, 'annotator_progress': 0.0, 'reviewer_progress': 0.0, 'creator': 'user@gmail.com', 'created': '2023-04-11T16:57:01.767677+05:00'},]
+
+Add images to the project.
+Now let's add images to the project which has not been created yet completely using client.project_upload_data():
+#Code
+    project_id = 'project_id' # a project id.      
+    folder = '/home/user/DirOfPics/' # you can upload pictures(.jpg, .png) locally.    
+    sample = client.project_upload_data(project_id, folder)
+    
+We can verify them using client.project('project_id') when project is fully created and images will be added to your images to do the project.

unitlab-2.4.0/README.md

@@ -0,0 +1,167 @@
+<p align="center">
+    <br>
+        <img src="assets/logo.png" width="400"/>
+    <br>
+<p>
+
+<p align="center">
+    <a href="https://pypi.org/project/unitlab/">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/unitlab">
+    </a>
+    <a href="https://pypi.org/project/unitlab/">
+        <img alt="Python" src="https://img.shields.io/pypi/pyversions/unitlab">
+    </a>
+    <a href="https://github.com/teamunitlab/unitlab-sdk">
+        <img alt="Downloads" src="https://img.shields.io/pypi/dm/unitlab">
+    </a>
+    <a href="https://github.com/teamunitlab/unitlab-sdk/blob/main/LICENSE.md">
+        <img alt="License" src="https://img.shields.io/pypi/l/unitlab">
+    </a>
+</p>
+
+[Unitlab.ai](https://unitlab.ai/) is an AI-driven data annotation platform that automates the collection of raw data, facilitating collaboration with human annotators to produce highly accurate labels for your machine learning models. With our service, you can optimize work efficiency, improve data quality, and reduce costs.
+
+![](assets/unitlabDoc.png)
+
+# Unitlab Python SDK
+
+Python SDK and CLI for the [Unitlab.ai](https://unitlab.ai/) data annotation platform. Manage projects, upload data, and download datasets programmatically or from the command line.
+
+## Installation
+
+```bash
+pip install --upgrade unitlab
+```
+
+Requires Python 3.10+.
+
+## Configuration
+
+Get your API key from [unitlab.ai](https://unitlab.ai/) and configure the CLI:
+
+```bash
+# Set API key
+unitlab configure --api-key YOUR_API_KEY
+
+# Set a custom API URL
+unitlab configure --api-url https://api.unitlab.ai
+
+# Set both at once
+unitlab configure --api-key YOUR_API_KEY --api-url https://api.unitlab.ai
+```
+
+Or set environment variables:
+
+```bash
+export UNITLAB_API_KEY=YOUR_API_KEY
+
+# Optional: point to a custom API server (e.g. self-hosted)
+export UNITLAB_API_URL=https://api.unitlab.ai
+```
+
+## Python SDK
+
+```python
+from unitlab import UnitlabClient
+
+# Initialize with an explicit key
+client = UnitlabClient(api_key="YOUR_API_KEY")
+
+# Or read from UNITLAB_API_KEY env var / config file
+client = UnitlabClient()
+```
+
+The client can also be used as a context manager:
+
+```python
+with UnitlabClient() as client:
+    projects = client.projects()
+```
+
+### Projects
+
+```python
+# List all projects
+projects = client.projects()
+
+# Get project details
+project = client.project("PROJECT_ID")
+
+# Get project members
+members = client.project_members("PROJECT_ID")
+```
+
+### Upload data
+
+```python
+client.project_upload_data(
+    project_id="PROJECT_ID",
+    directory="./images",
+)
+```
+
+Additional options for specific project types:
+
+```python
+# Text projects
+client.project_upload_data("PROJECT_ID", "./docs", sentences_per_chunk=10)
+
+# Video projects
+client.project_upload_data("PROJECT_ID", "./videos", fps=30.0)
+```
+
+### Datasets
+
+```python
+# List all datasets
+datasets = client.datasets()
+
+# Download annotations (COCO, YOLOv8, YOLOv5, etc.)
+path = client.dataset_download("DATASET_ID", export_type="COCO", split_type="train")
+
+# Download raw files
+folder = client.dataset_download_files("DATASET_ID")
+```
+
+## CLI
+
+### Projects
+
+```bash
+# List projects
+unitlab project list
+
+# Project details
+unitlab project detail PROJECT_ID
+
+# Project members
+unitlab project members PROJECT_ID
+
+# Upload data to a project
+unitlab project upload PROJECT_ID --directory ./images
+```
+
+### Datasets
+
+```bash
+# List datasets
+unitlab dataset list
+
+# Download annotations
+unitlab dataset download DATASET_ID --export-type COCO --split-type train
+
+# Download raw files
+unitlab dataset download DATASET_ID --download-type files
+```
+
+
+## Documentation
+
+See the [full documentation](https://docs.unitlab.ai/) for detailed guides:
+
+- [CLI reference](https://docs.unitlab.ai/cli-python-sdk/unitlab-cli)
+- [Python SDK quickstart](https://docs.unitlab.ai/cli-python-sdk/unitlab-python-sdk)
+
+## License
+
+[MIT](LICENSE.md)

unitlab-2.4.0/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "unitlab"
+version = "2.4.0"
+description = "Python SDK for the Unitlab.ai data annotation platform"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [{ name = "Unitlab Inc.", email = "team@unitlab.ai" }]
+keywords = ["unitlab", "annotation", "machine-learning", "data-labeling", "sdk"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+    "aiohttp>=3.9",
+    "aiofiles>=23.0",
+    "requests>=2.28",
+    "tqdm>=4.60",
+    "typer>=0.9",
+    "validators>=0.20",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "responses>=0.23",
+    "aioresponses>=0.7",
+    "ruff>=0.4",
+    "build>=1.0",
+    "twine>=5.0",
+]
+
+[project.scripts]
+unitlab = "unitlab.cli:app"
+
+[project.urls]
+Homepage = "https://unitlab.ai"
+Documentation = "https://docs.unitlab.ai"
+Repository = "https://github.com/teamunitlab/unitlab-sdk"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/unitlab"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP", "B", "SIM", "RUF"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

unitlab-2.4.0/src/unitlab/__init__.py

@@ -0,0 +1,7 @@
+from importlib.metadata import version
+
+from .client import UnitlabClient
+
+__version__ = version("unitlab")
+
+__all__ = ["UnitlabClient", "__version__"]

unitlab-2.4.0/src/unitlab/__main__.py

@@ -0,0 +1,3 @@
+from .cli import app
+
+app()