# AI Parrot: Python package for creating Chatbots
This is an open-source Python package for creating Chatbots based on Langchain and Navigator.
This README provides instructions for installation, development, testing, and releasing Parrot.
## Installation
**Creating a virtual environment:**
This is recommended for development and isolation from system-wide libraries.
Run the following command in your terminal:
Debian-based systems installation:
```
sudo apt install gcc python3.11-venv python3.11-full python3.11-dev libmemcached-dev zlib1g-dev build-essential libffi-dev unixodbc unixodbc-dev libsqliteodbc libev4 libev-dev
```
For Qdrant installation:
```
docker pull qdrant/qdrant
docker run -d -p 6333:6333 -p 6334:6334 --name qdrant -v $(pwd)/qdrant_storage:/qdrant/storage:z qdrant/qdrant
```
For VertexAI, creates a folder on "env" called "google" and copy the JSON credentials file into it.
```bash
make venv
```
This will create a virtual environment named `.venv`. To activate it, run:
```bash
source .venv/bin/activate # Linux/macOS
```
Once activated, install Parrot within the virtual environment:
```bash
make install
```
The output will remind you to activate the virtual environment before development.
**Optional** (for developers):
```bash
pip install -e .
```
## Start http server
```bash
python run.py
```
## Development Setup
This section explains how to set up your development environment:
1. **Install development requirements:**
```bash
make setup
```
This installs development dependencies like linters and test runners mentioned in the `docs/requirements-dev.txt` file.
2. **Install Parrot in editable mode:**
This allows you to make changes to the code and test them without reinstalling:
```bash
make dev
```
This uses `flit` to install Parrot in editable mode.
### Usage (Replace with actual usage instructions)
*Once you have set up your development environment, you can start using Parrot.*
#### Test with Code ChatBOT
* Set environment variables for:
[google]
GOOGLE_API_KEY=apikey
GOOGLE_CREDENTIALS_FILE=.../credentials.json
VERTEX_PROJECT_ID=vertex-project
VERTEX_REGION=region
* Run the chatbot:
```bash
python examples/test_agent.py
```
### Testing
To run the test suite:
```bash
make test
```
This will run tests using `coverage` to report on code coverage.
### Code Formatting
To format the code with black:
```bash
make format
```
### Linting
To lint the code for style and potential errors:
```bash
make lint
```
This uses `pylint` and `black` to check for issues.
### Releasing a New Version
This section outlines the steps for releasing a new version of Parrot:
1. **Ensure everything is clean and tested:**
```bash
make release
```
This runs `lint`, `test`, and `clean` tasks before proceeding.
2. **Publish the package:**
```bash
make release
```
This uses `flit` to publish the package to a repository like PyPI. You'll need to have publishing credentials configured for `flit`.
### Cleaning Up
To remove the virtual environment:
```bash
make distclean
```
### Contributing
We welcome contributions to Parrot! Please refer to the CONTRIBUTING.md file for guidelines on how to contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/phenobarbital/ai-parrot",
"name": "ai-parrot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.20",
"maintainer_email": null,
"keywords": "asyncio, asyncpg, aioredis, aiomcache, langchain, chatbot, agents",
"author": "Jesus Lara",
"author_email": "jesuslara@phenobarbital.info",
"download_url": "https://files.pythonhosted.org/packages/e2/ae/747f019148aba714e8ddad390c4ae3003f3e78d577648dad95a4144ad869/ai_parrot-0.4.11.tar.gz",
"platform": "POSIX",
"description": "# AI Parrot: Python package for creating Chatbots\nThis is an open-source Python package for creating Chatbots based on Langchain and Navigator.\nThis README provides instructions for installation, development, testing, and releasing Parrot.\n\n## Installation\n\n**Creating a virtual environment:**\n\nThis is recommended for development and isolation from system-wide libraries.\nRun the following command in your terminal:\n\nDebian-based systems installation:\n ```\n sudo apt install gcc python3.11-venv python3.11-full python3.11-dev libmemcached-dev zlib1g-dev build-essential libffi-dev unixodbc unixodbc-dev libsqliteodbc libev4 libev-dev\n ```\n\n For Qdrant installation:\n ```\n docker pull qdrant/qdrant\n docker run -d -p 6333:6333 -p 6334:6334 --name qdrant -v $(pwd)/qdrant_storage:/qdrant/storage:z qdrant/qdrant\n ```\n\nFor VertexAI, creates a folder on \"env\" called \"google\" and copy the JSON credentials file into it.\n\n ```bash\n make venv\n ```\n\n This will create a virtual environment named `.venv`. To activate it, run:\n\n ```bash\n source .venv/bin/activate # Linux/macOS\n ```\n\n Once activated, install Parrot within the virtual environment:\n\n ```bash\n make install\n ```\n The output will remind you to activate the virtual environment before development.\n\n **Optional** (for developers):\n ```bash\n pip install -e .\n ```\n\n## Start http server\n```bash\npython run.py\n```\n\n## Development Setup\n\nThis section explains how to set up your development environment:\n\n1. **Install development requirements:**\n\n ```bash\n make setup\n ```\n\n This installs development dependencies like linters and test runners mentioned in the `docs/requirements-dev.txt` file.\n\n2. **Install Parrot in editable mode:**\n\n This allows you to make changes to the code and test them without reinstalling:\n\n ```bash\n make dev\n ```\n\n This uses `flit` to install Parrot in editable mode.\n\n\n### Usage (Replace with actual usage instructions)\n\n*Once you have set up your development environment, you can start using Parrot.*\n\n#### Test with Code ChatBOT\n* Set environment variables for:\n [google]\n GOOGLE_API_KEY=apikey\n GOOGLE_CREDENTIALS_FILE=.../credentials.json\n VERTEX_PROJECT_ID=vertex-project\n VERTEX_REGION=region\n\n* Run the chatbot:\n ```bash\n python examples/test_agent.py\n ```\n\n### Testing\n\nTo run the test suite:\n\n```bash\nmake test\n```\n\nThis will run tests using `coverage` to report on code coverage.\n\n\n### Code Formatting\n\nTo format the code with black:\n\n```bash\nmake format\n```\n\n\n### Linting\n\nTo lint the code for style and potential errors:\n\n```bash\nmake lint\n```\n\nThis uses `pylint` and `black` to check for issues.\n\n\n### Releasing a New Version\n\nThis section outlines the steps for releasing a new version of Parrot:\n\n1. **Ensure everything is clean and tested:**\n\n ```bash\n make release\n ```\n\n This runs `lint`, `test`, and `clean` tasks before proceeding.\n\n2. **Publish the package:**\n\n ```bash\n make release\n ```\n\n This uses `flit` to publish the package to a repository like PyPI. You'll need to have publishing credentials configured for `flit`.\n\n\n### Cleaning Up\n\nTo remove the virtual environment:\n\n```bash\nmake distclean\n```\n\n\n### Contributing\n\nWe welcome contributions to Parrot! Please refer to the CONTRIBUTING.md file for guidelines on how to contribute.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Live Chatbots based on Langchain chatbots and Agents Integrated into Navigator Framework or used into any aiohttp applications.",
"version": "0.4.11",
"project_urls": {
"Documentation": "https://github.com/phenobarbital/ai-parrot/",
"Funding": "https://paypal.me/phenobarbital",
"Homepage": "https://github.com/phenobarbital/ai-parrot",
"Say Thanks!": "https://saythanks.io/to/phenobarbital",
"Source": "https://github.com/phenobarbital/ai-parrot",
"Tracker": "https://github.com/phenobarbital/ai-parrot/issues"
},
"split_keywords": [
"asyncio",
" asyncpg",
" aioredis",
" aiomcache",
" langchain",
" chatbot",
" agents"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dbba3751602d786b6c9f245f60097c5890a98f769f5f18bcc36377d2abe62c69",
"md5": "7b6f76117f185d1f5e6370698425c2cc",
"sha256": "fadfb5ca50061fa54e6d70ab51192d57b173f0a5531d45b9a0a13df5c48987b7"
},
"downloads": -1,
"filename": "ai_parrot-0.4.11-cp311-cp311-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "7b6f76117f185d1f5e6370698425c2cc",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.9.20",
"size": 804805,
"upload_time": "2024-12-17T18:45:05",
"upload_time_iso_8601": "2024-12-17T18:45:05.177162Z",
"url": "https://files.pythonhosted.org/packages/db/ba/3751602d786b6c9f245f60097c5890a98f769f5f18bcc36377d2abe62c69/ai_parrot-0.4.11-cp311-cp311-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e2ae747f019148aba714e8ddad390c4ae3003f3e78d577648dad95a4144ad869",
"md5": "bc6acc3cef9cb44fa9599c4e92e34604",
"sha256": "59b14000ce86358c483dce781a47608a9c792c3f597fb038320eff33e81eaca5"
},
"downloads": -1,
"filename": "ai_parrot-0.4.11.tar.gz",
"has_sig": false,
"md5_digest": "bc6acc3cef9cb44fa9599c4e92e34604",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.20",
"size": 1071749,
"upload_time": "2024-12-17T18:45:10",
"upload_time_iso_8601": "2024-12-17T18:45:10.311849Z",
"url": "https://files.pythonhosted.org/packages/e2/ae/747f019148aba714e8ddad390c4ae3003f3e78d577648dad95a4144ad869/ai_parrot-0.4.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 18:45:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phenobarbital",
"github_project": "ai-parrot",
"github_not_found": true,
"lcname": "ai-parrot"
}
JSON
