atlas-db-client 0.0.1__tar.gz

atlas_db_client-0.0.1/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# JetBrains
+.idea/

atlas_db_client-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 devfrank-m
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

atlas_db_client-0.0.1/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: atlas-db-client
+Version: 0.0.1
+Summary: The Python client for the Atlas vector database
+Project-URL: Homepage, https://github.com/devfrank-m/python-atlas-client
+Project-URL: Repository, https://github.com/devfrank-m/python-atlas-client
+Project-URL: Issues, https://github.com/devfrank-m/python-atlas-client/issues
+Author: devfrank-m
+License-Expression: MIT
+License-File: LICENSE
+Keywords: atlas,client,database,embeddings,vector
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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 :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# Atlas Client
+
+The Python client for the [Atlas](https://github.com/devfrank-m/atlas) vector database.
+
+## Installation
+
+```bash
+pip install atlas-db-client
+```
+
+## Quick Start
+
+```python
+from atlas_db_client import AtlasClient
+
+client = AtlasClient(host="http://localhost:8600")
+
+# Create a collection
+collection = client.create_collection(
+    name="my-collection",
+    dimension=128,
+    metric="cosine",
+)
+
+# Insert a vector
+result = client.insert_vector(
+    collection_id=collection.id,
+    vector=[0.1] * 128,
+    metadata={"label": "example"},
+)
+
+# Search
+response = client.search(
+    collection_id=collection.id,
+    vector=[0.1] * 128,
+    k=5,
+)
+
+for r in response.results:
+    print(r.id, r.score)
+```
+
+## Async Support
+
+```python
+from atlas_db_client import AsyncAtlasClient
+
+async with AsyncAtlasClient() as client:
+    collection = await client.create_collection(
+        name="my-collection",
+        dimension=128,
+        metric="cosine",
+    )
+```
+
+## License
+
+MIT

atlas_db_client-0.0.1/README.md

@@ -0,0 +1,58 @@
+# Atlas Client
+
+The Python client for the [Atlas](https://github.com/devfrank-m/atlas) vector database.
+
+## Installation
+
+```bash
+pip install atlas-db-client
+```
+
+## Quick Start
+
+```python
+from atlas_db_client import AtlasClient
+
+client = AtlasClient(host="http://localhost:8600")
+
+# Create a collection
+collection = client.create_collection(
+    name="my-collection",
+    dimension=128,
+    metric="cosine",
+)
+
+# Insert a vector
+result = client.insert_vector(
+    collection_id=collection.id,
+    vector=[0.1] * 128,
+    metadata={"label": "example"},
+)
+
+# Search
+response = client.search(
+    collection_id=collection.id,
+    vector=[0.1] * 128,
+    k=5,
+)
+
+for r in response.results:
+    print(r.id, r.score)
+```
+
+## Async Support
+
+```python
+from atlas_db_client import AsyncAtlasClient
+
+async with AsyncAtlasClient() as client:
+    collection = await client.create_collection(
+        name="my-collection",
+        dimension=128,
+        metric="cosine",
+    )
+```
+
+## License
+
+MIT

atlas_db_client-0.0.1/atlas_db_client/__init__.py

@@ -0,0 +1,25 @@
+__version__ = "0.0.1"
+
+from ._async_client import AsyncAtlasClient
+from ._client import AtlasClient
+from ._exceptions import AtlasError, NotFoundError, ValidationError
+from ._models import (
+    Collection,
+    Filter,
+    SearchResponse,
+    SearchResult,
+    VectorInsertResult,
+)
+
+__all__ = [
+    "AtlasClient",
+    "AsyncAtlasClient",
+    "AtlasError",
+    "NotFoundError",
+    "ValidationError",
+    "Collection",
+    "Filter",
+    "SearchResponse",
+    "SearchResult",
+    "VectorInsertResult",
+]

atlas_db_client-0.0.1/atlas_db_client/_async_client.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from ._base import (
+    DEFAULT_HOST,
+    DEFAULT_TIMEOUT,
+    _build_client_kwargs,
+    _build_create_body,
+    _build_insert_body,
+    _build_search_body,
+    _parse_collection,
+    _parse_insert,
+    _parse_search,
+    _raise_for_status,
+)
+from ._models import Collection, Filter, SearchResponse, VectorInsertResult
+
+
+class AsyncAtlasClient:
+    def __init__(
+        self,
+        host: str = DEFAULT_HOST,
+        timeout: float = DEFAULT_TIMEOUT,
+        headers: dict[str, str] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        self._client = httpx.AsyncClient(
+            **_build_client_kwargs(host, timeout, headers, **kwargs)
+        )
+
+    async def _request(self, method: str, path: str, **kwargs: Any) -> dict[str, Any]:
+        response = await self._client.request(method, path, **kwargs)
+        _raise_for_status(response)
+        return response.json()
+
+    async def create_collection(
+        self,
+        name: str,
+        dimension: int,
+        metric: str,
+        index: str | None = None,
+    ) -> Collection:
+        data = await self._request(
+            "POST",
+            "/collections",
+            json=_build_create_body(name, dimension, metric, index),
+        )
+        return _parse_collection(data)
+
+    async def get_collection(self, collection_id: str) -> Collection:
+        data = await self._request("GET", f"/collections/{collection_id}")
+        return _parse_collection(data)
+
+    async def insert_vector(
+        self,
+        collection_id: str,
+        vector: list[float],
+        metadata: dict[str, Any],
+        external_id: str | None = None,
+    ) -> VectorInsertResult:
+        data = await self._request(
+            "POST",
+            f"/collections/{collection_id}/vectors",
+            json=_build_insert_body(vector, metadata, external_id),
+        )
+        return _parse_insert(data)
+
+    async def search(
+        self,
+        collection_id: str,
+        vector: list[float],
+        k: int,
+        filter: Filter | None = None,
+    ) -> SearchResponse:
+        data = await self._request(
+            "POST",
+            f"/collections/{collection_id}/search",
+            json=_build_search_body(vector, k, filter),
+        )
+        return _parse_search(data)
+
+    async def close(self) -> None:
+        await self._client.aclose()
+
+    async def __aenter__(self) -> AsyncAtlasClient:
+        return self
+
+    async def __aexit__(self, *args: Any) -> None:
+        await self.close()

atlas_db_client-0.0.1/atlas_db_client/_base.py

@@ -0,0 +1,109 @@
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from ._exceptions import AtlasError, NotFoundError, ValidationError
+from ._models import (
+    Collection,
+    Filter,
+    SearchResponse,
+    SearchResult,
+    VectorInsertResult,
+)
+
+DEFAULT_HOST = "http://localhost:8600"
+DEFAULT_TIMEOUT = 30.0
+
+
+def _build_client_kwargs(
+    host: str,
+    timeout: float,
+    headers: dict[str, str] | None,
+    **kwargs: Any,
+) -> dict[str, Any]:
+    h = {"Content-Type": "application/json"}
+    if headers:
+        h.update(headers)
+    return {"base_url": host, "timeout": timeout, "headers": h, **kwargs}
+
+
+def _raise_for_status(response: httpx.Response) -> None:
+    if response.is_success:
+        return
+    try:
+        body = response.json()
+        msg = body.get("error", response.text)
+    except Exception:
+        msg = response.text
+
+    status = response.status_code
+    if status == 404:
+        raise NotFoundError(status, msg)
+    if status == 400:
+        raise ValidationError(status, msg)
+    raise AtlasError(status, msg)
+
+
+def _parse_collection(data: dict[str, Any]) -> Collection:
+    return Collection(
+        id=data["id"],
+        name=data["name"],
+        dimension=data.get("dimension"),
+        metric=data.get("metric"),
+        vector_count=data.get("vector_count"),
+    )
+
+
+def _parse_insert(data: dict[str, Any]) -> VectorInsertResult:
+    return VectorInsertResult(id=data["id"])
+
+
+def _parse_search(data: dict[str, Any]) -> SearchResponse:
+    return SearchResponse(
+        results=[
+            SearchResult(
+                id=r["id"],
+                score=r["score"],
+                metadata=r["metadata"],
+                vector=r.get("vector"),
+                external_id=r.get("external_id"),
+            )
+            for r in data.get("results", [])
+        ]
+    )
+
+
+def _build_insert_body(
+    vector: list[float],
+    metadata: dict[str, Any],
+    external_id: str | None,
+) -> dict[str, Any]:
+    body: dict[str, Any] = {"vector": vector, "metadata": metadata}
+    if external_id is not None:
+        body["external_id"] = external_id
+    return body
+
+
+def _build_search_body(
+    vector: list[float],
+    k: int,
+    filter: Filter | None,
+) -> dict[str, Any]:
+    body: dict[str, Any] = {"vector": vector, "k": k}
+    if filter is not None:
+        body["filter"] = filter.to_dict()
+    return body
+
+
+def _build_create_body(
+    name: str,
+    dimension: int,
+    metric: str,
+    index: str | None,
+) -> dict[str, Any]:
+    body: dict[str, Any] = {"name": name, "dimension": dimension, "metric": metric}
+    if index is not None:
+        body["index"] = index
+    return body

atlas_db_client-0.0.1/atlas_db_client/_client.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from ._base import (
+    DEFAULT_HOST,
+    DEFAULT_TIMEOUT,
+    _build_client_kwargs,
+    _build_create_body,
+    _build_insert_body,
+    _build_search_body,
+    _parse_collection,
+    _parse_insert,
+    _parse_search,
+    _raise_for_status,
+)
+from ._models import Collection, Filter, SearchResponse, VectorInsertResult
+
+
+class AtlasClient:
+    def __init__(
+        self,
+        host: str = DEFAULT_HOST,
+        timeout: float = DEFAULT_TIMEOUT,
+        headers: dict[str, str] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        self._client = httpx.Client(
+            **_build_client_kwargs(host, timeout, headers, **kwargs)
+        )
+
+    def _request(self, method: str, path: str, **kwargs: Any) -> dict[str, Any]:
+        response = self._client.request(method, path, **kwargs)
+        _raise_for_status(response)
+        return response.json()
+
+    def create_collection(
+        self,
+        name: str,
+        dimension: int,
+        metric: str,
+        index: str | None = None,
+    ) -> Collection:
+        data = self._request(
+            "POST",
+            "/collections",
+            json=_build_create_body(name, dimension, metric, index),
+        )
+        return _parse_collection(data)
+
+    def get_collection(self, collection_id: str) -> Collection:
+        data = self._request("GET", f"/collections/{collection_id}")
+        return _parse_collection(data)
+
+    def insert_vector(
+        self,
+        collection_id: str,
+        vector: list[float],
+        metadata: dict[str, Any],
+        external_id: str | None = None,
+    ) -> VectorInsertResult:
+        data = self._request(
+            "POST",
+            f"/collections/{collection_id}/vectors",
+            json=_build_insert_body(vector, metadata, external_id),
+        )
+        return _parse_insert(data)
+
+    def search(
+        self,
+        collection_id: str,
+        vector: list[float],
+        k: int,
+        filter: Filter | None = None,
+    ) -> SearchResponse:
+        data = self._request(
+            "POST",
+            f"/collections/{collection_id}/search",
+            json=_build_search_body(vector, k, filter),
+        )
+        return _parse_search(data)
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> AtlasClient:
+        return self
+
+    def __exit__(self, *args: Any) -> None:
+        self.close()

atlas_db_client-0.0.1/atlas_db_client/_exceptions.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass
+class AtlasError(Exception):
+    status_code: int
+    message: str
+
+    def __str__(self) -> str:
+        return f"[{self.status_code}] {self.message}"
+
+
+class ConnectionError(AtlasError):
+    pass
+
+
+class NotFoundError(AtlasError):
+    pass
+
+
+class ValidationError(AtlasError):
+    pass

atlas_db_client-0.0.1/atlas_db_client/_models.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any
+
+
+@dataclass
+class Collection:
+    id: str
+    name: str
+    dimension: int | None = None
+    metric: str | None = None
+    vector_count: int | None = None
+
+
+@dataclass
+class VectorInsertResult:
+    id: int
+
+
+@dataclass
+class SearchResult:
+    id: int
+    score: float
+    metadata: dict[str, Any]
+    vector: list[float] | None = None
+    external_id: str | None = None
+
+
+@dataclass
+class SearchResponse:
+    results: list[SearchResult] = field(default_factory=list)
+
+
+@dataclass
+class Filter:
+    key: str
+    value: Any
+    op: str = "eq"
+
+    def to_dict(self) -> dict[str, Any]:
+        return {"op": self.op, "key": self.key, "value": self.value}

atlas_db_client-0.0.1/pyproject.toml

@@ -0,0 +1,60 @@
+[project]
+name = "atlas-db-client"
+version = "0.0.1"
+description = "The Python client for the Atlas vector database"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    { name = "devfrank-m" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Database",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+keywords = ["atlas", "vector", "database", "client", "embeddings"]
+
+[project.urls]
+Homepage = "https://github.com/devfrank-m/python-atlas-client"
+Repository = "https://github.com/devfrank-m/python-atlas-client"
+Issues = "https://github.com/devfrank-m/python-atlas-client/issues"
+
+
+[dependency-groups]
+dev = [
+    "black>=26.3.1",
+    "ruff>=0.15.6",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["atlas_db_client"]
+
+[tool.hatch.build.targets.sdist]
+include = ["atlas_db_client", "README.md", "LICENSE"]
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+version_variables = ["atlas_db_client/__init__.py:__version__"]
+branch = "main"
+build_command = "pip install build && python -m build"
+commit_message = "chore(release): v{version}"
+
+[tool.semantic_release.changelog]
+changelog_file = "CHANGELOG.md"
+
+[tool.semantic_release.remote]
+type = "github"
+token = { env = "GH_TOKEN" }