README.md

Server

Requirements

• OpenAI API account: https://platform.openai.com/
• Pinecone account: https://www.pinecone.io/
• python 3.10
• Poetry: curl -sSL https://install.python-poetry.org | python3 - --version 1.4.0
• pipx: pip install --user pipx
• nox: pipx install nox && pipx inject nox nox-poetry

Installation

poetry install
python -m spacy download en_core_web_sm

create a .env file with the following variables:

OPENAI_KEY=your_openai_api_key (found on API keys page)
OPENAI_ORG=your_openai_org (found on Settings page)
PINECONE_KEY=your_pinecone_api_key (found on API keys page)

Usage

uvicorn server.main:app --reload

Development

These command-line utilities check code quality.

pre-commit run -a
pytest
nox

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Server is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.