embcli-chroma


Nameembcli-chroma JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryChromaDB integration for embcli
upload_time2025-07-27 08:48:00
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseApache-2.0
keywords cli embeddings llm nlp
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # embcli-chroma

[![PyPI](https://img.shields.io/pypi/v/embcli-chroma?label=PyPI)](https://pypi.org/project/embcli-chroma/)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mocobeta/embcli/ci-chroma.yml?logo=github&label=tests)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/embcli-chroma)

chroma plugin for embcli, a command-line interface for embeddings.

## Reference

- [Chroma](https://www.trychroma.com/)

## Installation

```bash
pip install embcli-chroma
```

## Quick Start

### Use Chroma as a Vector Database

```bash
# show general usage of emb command.
emb --help

# list all available vector stores.
emb vector-stores
ChromaVectorStore
    Vendor: chroma

# index example documents to a Chroma collection. Default chroma db path is `./chroma`.
emb ingest-sample -m sbert -c catcafe --corpus cat-names-en --vector-store chroma

# or, you can give the path to your db path.
emb ingest-sample -m sbert -c catcafe --corpus cat-names-en --vector-store chroma --persist-path /path/to/chroma

# search indexed documents in a Chroma collection.
emb search -m sbert -c catcafe -q "Who's the naughtiest one?" --vector-store chroma

# or, you can give the path to your db path.
emb search -m sbert -c catcafe -q "Who's the naughtiest one?" --vector-store chroma --persist-path /path/to/chroma
```

## Development

See the [main README](https://github.com/mocobeta/embcli/blob/main/README.md) for general development instructions.

### Run Tests

```bash
uv run --package embcli-chroma pytest packages/embcli-chroma/tests
```

### Run Linter and Formatter

```bash
uv run ruff check --fix packages/embcli-chroma
uv run ruff format packages/embcli-chroma
```

### Run Type Checker

```bash
uv run --package embcli-chroma pyright packages/embcli-chroma
```

## Build

```bash
uv build --package embcli-chroma
```

## License

Apache License 2.0

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "embcli-chroma",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "cli, embeddings, llm, nlp",
    "author": null,
    "author_email": "Tomoko Uchida <tomoko.uchida.1111@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/7b/de/2bc6842165e2937a2ec8d01122adbcb18606d6541ba6b6beedbe6c27370c/embcli_chroma-0.1.0.tar.gz",
    "platform": null,
    "description": "# embcli-chroma\n\n[![PyPI](https://img.shields.io/pypi/v/embcli-chroma?label=PyPI)](https://pypi.org/project/embcli-chroma/)\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mocobeta/embcli/ci-chroma.yml?logo=github&label=tests)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/embcli-chroma)\n\nchroma plugin for embcli, a command-line interface for embeddings.\n\n## Reference\n\n- [Chroma](https://www.trychroma.com/)\n\n## Installation\n\n```bash\npip install embcli-chroma\n```\n\n## Quick Start\n\n### Use Chroma as a Vector Database\n\n```bash\n# show general usage of emb command.\nemb --help\n\n# list all available vector stores.\nemb vector-stores\nChromaVectorStore\n    Vendor: chroma\n\n# index example documents to a Chroma collection. Default chroma db path is `./chroma`.\nemb ingest-sample -m sbert -c catcafe --corpus cat-names-en --vector-store chroma\n\n# or, you can give the path to your db path.\nemb ingest-sample -m sbert -c catcafe --corpus cat-names-en --vector-store chroma --persist-path /path/to/chroma\n\n# search indexed documents in a Chroma collection.\nemb search -m sbert -c catcafe -q \"Who's the naughtiest one?\" --vector-store chroma\n\n# or, you can give the path to your db path.\nemb search -m sbert -c catcafe -q \"Who's the naughtiest one?\" --vector-store chroma --persist-path /path/to/chroma\n```\n\n## Development\n\nSee the [main README](https://github.com/mocobeta/embcli/blob/main/README.md) for general development instructions.\n\n### Run Tests\n\n```bash\nuv run --package embcli-chroma pytest packages/embcli-chroma/tests\n```\n\n### Run Linter and Formatter\n\n```bash\nuv run ruff check --fix packages/embcli-chroma\nuv run ruff format packages/embcli-chroma\n```\n\n### Run Type Checker\n\n```bash\nuv run --package embcli-chroma pyright packages/embcli-chroma\n```\n\n## Build\n\n```bash\nuv build --package embcli-chroma\n```\n\n## License\n\nApache License 2.0\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "ChromaDB integration for embcli",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://embcli.mocobeta.dev/",
        "Repository": "https://github.com/mocobeta/embcli"
    },
    "split_keywords": [
        "cli",
        " embeddings",
        " llm",
        " nlp"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4ee153c467bc2f85f6d707f42d0944732ff72b731fcfd8e71a124594bee74529",
                "md5": "2a39854027ed124a04b97b28c094febf",
                "sha256": "07419cde4099d923614cf071d08686d2d0c8e7c7ab077a0278b940c86b159c4f"
            },
            "downloads": -1,
            "filename": "embcli_chroma-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2a39854027ed124a04b97b28c094febf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 3467,
            "upload_time": "2025-07-27T08:47:59",
            "upload_time_iso_8601": "2025-07-27T08:47:59.703037Z",
            "url": "https://files.pythonhosted.org/packages/4e/e1/53c467bc2f85f6d707f42d0944732ff72b731fcfd8e71a124594bee74529/embcli_chroma-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7bde2bc6842165e2937a2ec8d01122adbcb18606d6541ba6b6beedbe6c27370c",
                "md5": "56b1d9c7b97c000d3f54dc0e87da3dad",
                "sha256": "f0793147c1427e703e79135cf262ff93665c89bef7e8b712fb53ee6b460f14d8"
            },
            "downloads": -1,
            "filename": "embcli_chroma-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "56b1d9c7b97c000d3f54dc0e87da3dad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 4044,
            "upload_time": "2025-07-27T08:48:00",
            "upload_time_iso_8601": "2025-07-27T08:48:00.640193Z",
            "url": "https://files.pythonhosted.org/packages/7b/de/2bc6842165e2937a2ec8d01122adbcb18606d6541ba6b6beedbe6c27370c/embcli_chroma-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-27 08:48:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mocobeta",
    "github_project": "embcli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "embcli-chroma"
}
        
Elapsed time: 2.02015s