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

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.1.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

pinetext-0.1.1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pinetext-0.1.1.tar.gz
Algorithm Hash digest
SHA256 38de60336356b774647481660e971fd43e00d193fe121197e286cc29ebfefd69
MD5 a7474bc132d58829d1ee43051cc964df
BLAKE2b-256 860e33aebfbc7f0bc3d5cc25a52af04f6b6a322a0238b5c0ceef37d393578b5d

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for pinetext-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 611382bc9ceaafee7b258f821123cde68b3efa39d0362bee39efb29c266ec97b
MD5 a4cdc47d8acf9eaf98418cd3ca8847ab
BLAKE2b-256 da0cd54ff5c251132f5622e0f28f18307eb33639ce29c785a8eb4b6e77575ba0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pinetext-0.1.1-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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page