Skip to main content

PineText

Project description

PineText

test codecov PyPI - Version

A lightweight assistant built using Pinecone that helps create RAG-based chat applications for reasoning over documents, retrieving relevant context, and providing grounded answers.

Getting Started

Use uv to add and manage PineText as a dependency in your project, or install it directly via uv pip install or pip install. See the Installation section of the documentation for full installation instructions and more details.

uv add pinetext

It can be embedded in and run directly from your application.

# app.py
from pinetext import PineText

def main():
    pt = PineText()
    pt.run()

It can also be launched from the command line using the provided CLI without modifying the source code.

pinetext

Or in an ephemeral, isolated environment using uvx. Check out the Using tools guide for more details.

uvx pinetext

Configuration

Place documents in the data folder and make sure to set PINECONE_API_KEY and the assistant name before starting PineText.

export PINETEXT_PINECONE__API_KEY=your-api-key
export PINETEXT_PINECONE__ASSISTANT=assistant-name
export PINETEXT_PINECONE__DATA_DIR=data
export PINETEXT_PINECONE__MODEL=o4-mini

These settings can also be specified in a .env file in the working directory.

pinetext_pinecone__api_key=your-api-key
pinetext_pinecone__assistant=assistant-name
pinetext_pinecone__data_dir=data
pinetext_pinecone__model=o4-mini

Docker

The PineText CLI can be deployed as a Docker container as follows:

docker run -it \
  --name pinetext \
  --env-file .env \
  -v $(pwd)/data:/app/data
  ghcr.io/ezhuk/pinetext:latest

Or using Docker Compose:

docker compose up

License

The server is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pinetext-0.1.9.tar.gz (91.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pinetext-0.1.9-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file pinetext-0.1.9.tar.gz.

File metadata

  • Download URL: pinetext-0.1.9.tar.gz
  • Upload date:
  • Size: 91.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pinetext-0.1.9.tar.gz
Algorithm Hash digest
SHA256 e3304e58904c07eb3790376a151ca7e9a9be2f685ab39606e1a945f8976755be
MD5 847d73001529ff6765458cd37e870f3f
BLAKE2b-256 acc3b4d8cb668e3bbeb0e46469f28e337651218829b8f7a01dc6aa797d58b9c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for pinetext-0.1.9.tar.gz:

Publisher: pypi.yml on ezhuk/pinetext

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pinetext-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: pinetext-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pinetext-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 5822311f56de87f9c8b43fde5e279f84d128bdba1c79e71730d13a0e726f59f0
MD5 16d8445e59b1601d8de53bb956e0b25c
BLAKE2b-256 2424a39cce9b73ddfece431298098f2ef671024847e6bbc6eb132477ccc29200

See more details on using hashes here.

Provenance

The following attestation bundles were made for pinetext-0.1.9-py3-none-any.whl:

Publisher: pypi.yml on ezhuk/pinetext

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page