<p align="center">
<img alt="PAutoBot" style="width: 128px; max-width: 100%; height: auto;" src="https://raw.githubusercontent.com/nrl-ai/pautobot/main/docs/pautobot.png"/>
<h1 align="center">🔥 PⒶutoBot 🔥</h1>
<p align="center" style="font-size:18px"><b>Private AutoGPT Robot</b> - Your private task assistant with GPT!</p>
</p>
- 🔥 **Chat** to your offline **LLMs on CPU Only**. **100% private**, no data leaves your execution environment at any point.
- 🔥 **Ask questions** to your documents without an internet connection. Engine developed based on [PrivateGPT](https://github.com/imartinez/privateGPT).
- 🔥 **Automate tasks** easily with **PAutoBot plugins**. Easy for everyone.
- 🔥 **Easy coding structure** with **Next.js** and **Python**. Easy to understand and modify.
- 🔥 **Built with** [LangChain](https://github.com/hwchase17/langchain), [GPT4All](https://github.com/nomic-ai/gpt4all), [Chroma](https://www.trychroma.com/), [SentenceTransformers](https://www.sbert.net/), [PrivateGPT](https://github.com/imartinez/privateGPT).
**The supported extensions are:**
- `.csv`: CSV,
- `.docx`: Word Document,
- `.doc`: Word Document,
- `.enex`: EverNote,
- `.eml`: Email,
- `.epub`: EPub,
- `.html`: HTML File,
- `.md`: Markdown,
- `.msg`: Outlook Message,
- `.odt`: Open Document Text,
- `.pdf`: Portable Document Format (PDF),
- `.pptx` : PowerPoint Document,
- `.ppt` : PowerPoint Document,
- `.txt`: Text file (UTF-8),
## I. Installation and Usage
### 1. Installation
- Python 3.8 or higher.
- Install **PAutoBot**:
```shell
pip install pautobot
```
### 2. Usage
- Run the app:
```shell
python -m pautobot.app
```
or just:
```shell
pautobot
```
- Go to <http://localhost:5678/> to see the user interface. You can choose one of the two modes:
- **Chat Only**
- **Documents Q&A**
- Upload some documents to the app (see the supported extensions above). You can try [docs/python3.11.3_lite.zip](docs/python3.11.3_lite.zip) for a quick start. This zip file contains 45 files from the [Python 3.11.3 documentation](https://docs.python.org/3/download.html).
- Force ingesting documents with **Ingest Data** button.
You can also run PAutoBot publicly to your network or change the port with parameters. Example:
```shell
pautobot --host 0.0.0.0 --port 8080
```
## II. Development
### 1. Clone the source code
```shell
git clone https://github.com/nrl-ai/pautobot
cd pautobot
```
### 2. Run your backend
- Python 3.8 or higher.
- To install Pautobot from source, from `pautobot` source code directory, run:
```shell
pip install -e .
```
- Run the app:
```shell
python -m pautobot.app
```
- Go to <http://localhost:5678/> to see the user interface.
### 2. Run your frontend
- Install the dependencies:
```shell
cd frontend
npm install
```
- Run the app:
```shell
npm run dev
```
- Go to <http://localhost:3000/> to see the user interface. Use this address to develop the frontend.
Raw data
{
"_id": null,
"home_page": "https://github.com/vietanhdev/pautobot",
"name": "privategpt",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Personal Assistant,Automation,GPT,LLM,PrivateGPT",
"author": "Viet-Anh Nguyen",
"author_email": "vietanh.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6b/59/d4ebb8c7c4a6e3312a5d9c7f3e03d895e81961a255a69f1b50888c7e3161/privategpt-0.0.26.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img alt=\"PAutoBot\" style=\"width: 128px; max-width: 100%; height: auto;\" src=\"https://raw.githubusercontent.com/nrl-ai/pautobot/main/docs/pautobot.png\"/>\n <h1 align=\"center\">\ud83d\udd25 P\u24b6utoBot \ud83d\udd25</h1>\n <p align=\"center\" style=\"font-size:18px\"><b>Private AutoGPT Robot</b> - Your private task assistant with GPT!</p>\n</p>\n\n- \ud83d\udd25 **Chat** to your offline **LLMs on CPU Only**. **100% private**, no data leaves your execution environment at any point.\n- \ud83d\udd25 **Ask questions** to your documents without an internet connection. Engine developed based on [PrivateGPT](https://github.com/imartinez/privateGPT).\n- \ud83d\udd25 **Automate tasks** easily with **PAutoBot plugins**. Easy for everyone.\n- \ud83d\udd25 **Easy coding structure** with **Next.js** and **Python**. Easy to understand and modify.\n- \ud83d\udd25 **Built with** [LangChain](https://github.com/hwchase17/langchain), [GPT4All](https://github.com/nomic-ai/gpt4all), [Chroma](https://www.trychroma.com/), [SentenceTransformers](https://www.sbert.net/), [PrivateGPT](https://github.com/imartinez/privateGPT).\n\n\n\n**The supported extensions are:**\n\n- `.csv`: CSV,\n- `.docx`: Word Document,\n- `.doc`: Word Document,\n- `.enex`: EverNote,\n- `.eml`: Email,\n- `.epub`: EPub,\n- `.html`: HTML File,\n- `.md`: Markdown,\n- `.msg`: Outlook Message,\n- `.odt`: Open Document Text,\n- `.pdf`: Portable Document Format (PDF),\n- `.pptx` : PowerPoint Document,\n- `.ppt` : PowerPoint Document,\n- `.txt`: Text file (UTF-8),\n\n## I. Installation and Usage\n\n### 1. Installation\n\n- Python 3.8 or higher.\n- Install **PAutoBot**:\n\n```shell\npip install pautobot\n```\n\n### 2. Usage\n\n- Run the app:\n\n```shell\npython -m pautobot.app\n```\n\nor just:\n\n```shell\npautobot\n```\n\n- Go to <http://localhost:5678/> to see the user interface. You can choose one of the two modes:\n - **Chat Only**\n - **Documents Q&A**\n- Upload some documents to the app (see the supported extensions above). You can try [docs/python3.11.3_lite.zip](docs/python3.11.3_lite.zip) for a quick start. This zip file contains 45 files from the [Python 3.11.3 documentation](https://docs.python.org/3/download.html).\n- Force ingesting documents with **Ingest Data** button.\n\nYou can also run PAutoBot publicly to your network or change the port with parameters. Example:\n\n```shell\npautobot --host 0.0.0.0 --port 8080\n```\n\n## II. Development\n\n### 1. Clone the source code\n\n```shell\ngit clone https://github.com/nrl-ai/pautobot\ncd pautobot\n```\n\n### 2. Run your backend\n\n- Python 3.8 or higher.\n- To install Pautobot from source, from `pautobot` source code directory, run:\n\n```shell\npip install -e .\n```\n\n- Run the app:\n\n```shell\npython -m pautobot.app\n```\n\n- Go to <http://localhost:5678/> to see the user interface.\n\n### 2. Run your frontend\n\n- Install the dependencies:\n\n```shell\ncd frontend\nnpm install\n```\n\n- Run the app:\n\n```shell\nnpm run dev\n```\n\n- Go to <http://localhost:3000/> to see the user interface. Use this address to develop the frontend.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Private AutoGPT Robot - Your private task assistant with GPT!",
"version": "0.0.26",
"project_urls": {
"Homepage": "https://github.com/vietanhdev/pautobot"
},
"split_keywords": [
"personal assistant",
"automation",
"gpt",
"llm",
"privategpt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e805aba111c7d96271b712a6596df75e3f090a5b794b0e6aed7a161950b2b00f",
"md5": "ca52d608818b91f35262a1c54db9ea65",
"sha256": "5d616adaf27e99e38b92ab97fbc4b323bde4d75522baa45e8c14db9f695010c7"
},
"downloads": -1,
"filename": "privategpt-0.0.26-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca52d608818b91f35262a1c54db9ea65",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 384117,
"upload_time": "2023-06-10T18:28:02",
"upload_time_iso_8601": "2023-06-10T18:28:02.018684Z",
"url": "https://files.pythonhosted.org/packages/e8/05/aba111c7d96271b712a6596df75e3f090a5b794b0e6aed7a161950b2b00f/privategpt-0.0.26-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b59d4ebb8c7c4a6e3312a5d9c7f3e03d895e81961a255a69f1b50888c7e3161",
"md5": "fc39bd17864d5d6173ed0d044836a7c1",
"sha256": "eb03fd2b526ac386cea8102f151f8c0f6ce0ddae7338c621b97eb93e879b644f"
},
"downloads": -1,
"filename": "privategpt-0.0.26.tar.gz",
"has_sig": false,
"md5_digest": "fc39bd17864d5d6173ed0d044836a7c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 374775,
"upload_time": "2023-06-10T18:28:04",
"upload_time_iso_8601": "2023-06-10T18:28:04.377039Z",
"url": "https://files.pythonhosted.org/packages/6b/59/d4ebb8c7c4a6e3312a5d9c7f3e03d895e81961a255a69f1b50888c7e3161/privategpt-0.0.26.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-10 18:28:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vietanhdev",
"github_project": "pautobot",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "langchain",
"specs": [
[
"==",
"0.0.194"
]
]
},
{
"name": "gpt4all",
"specs": [
[
"==",
"0.3.0"
]
]
},
{
"name": "chromadb",
"specs": [
[
"==",
"0.3.23"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.0.2"
]
]
},
{
"name": "pdfminer.six",
"specs": [
[
"==",
"20221105"
]
]
},
{
"name": "unstructured",
"specs": [
[
"==",
"0.6.6"
]
]
},
{
"name": "extract-msg",
"specs": [
[
"==",
"0.41.1"
]
]
},
{
"name": "tabulate",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "pandoc",
"specs": [
[
"==",
"2.3"
]
]
},
{
"name": "pypandoc",
"specs": [
[
"==",
"1.11"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.65.0"
]
]
},
{
"name": "python-multipart",
"specs": [
[
"==",
"0.0.6"
]
]
},
{
"name": "fastapi",
"specs": [
[
"==",
"0.96.0"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"2.0.15"
]
]
},
{
"name": "alembic",
"specs": [
[
"==",
"1.11.1"
]
]
},
{
"name": "sentence_transformers",
"specs": [
[
"==",
"2.2.2"
]
]
},
{
"name": "requests",
"specs": []
}
],
"lcname": "privategpt"
}
JSON
