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(data_dir="./data")
    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.3.0.tar.gz (96.7 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.3.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pinetext-0.3.0.tar.gz
Algorithm Hash digest
SHA256 63c5ea0038933306a03c152086e833633c1aee2a4f0a978340af74f2ebaea5ed
MD5 9a6a88b2567f891dec2d5d47cb69bfbc
BLAKE2b-256 1e7c6926f62a3d5c98bfdd99bcd784981f7ae700376d73591b228dd320c2ef60

See more details on using hashes here.

Provenance

The following attestation bundles were made for pinetext-0.3.0.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.3.0-py3-none-any.whl.

File metadata

  • Download URL: pinetext-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 5.5 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d8b7bed9a8bddb592fc2df10a76b6e399241f0a866e365e413caaa1fa1f03f8
MD5 338872782b0d4edd73105e7a46819aaf
BLAKE2b-256 7ff99526abba315c877c39c7e8f1f690856705a01a3693ce5418d88bd248faaf

See more details on using hashes here.

Provenance

The following attestation bundles were made for pinetext-0.3.0-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