{"id":19814782,"url":"https://github.com/arc53/tg-bot-docsgpt-extenstion","last_synced_at":"2025-02-28T14:28:13.909Z","repository":{"id":241279919,"uuid":"804775033","full_name":"arc53/tg-bot-docsgpt-extenstion","owner":"arc53","description":"DocsGPT extension to deploy telegram bots","archived":false,"fork":false,"pushed_at":"2024-07-06T09:17:07.000Z","size":9,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-19T10:11:40.403Z","etag":null,"topics":["ai","bot","docsgpt","gpt","telegram"],"latest_commit_sha":null,"homepage":"https://www.docsgpt.cloud/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arc53.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-23T08:42:38.000Z","updated_at":"2024-11-01T08:22:32.000Z","dependencies_parsed_at":"2024-05-23T10:03:45.354Z","dependency_job_id":null,"html_url":"https://github.com/arc53/tg-bot-docsgpt-extenstion","commit_stats":null,"previous_names":["arc53/tg-bot-docsgpt-extenstion"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arc53%2Ftg-bot-docsgpt-extenstion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arc53%2Ftg-bot-docsgpt-extenstion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arc53%2Ftg-bot-docsgpt-extenstion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arc53%2Ftg-bot-docsgpt-extenstion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arc53","download_url":"https://codeload.github.com/arc53/tg-bot-docsgpt-extenstion/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233456042,"owners_count":18678963,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","bot","docsgpt","gpt","telegram"],"created_at":"2024-11-12T10:03:05.419Z","updated_at":"2025-01-11T07:40:57.521Z","avatar_url":"https://github.com/arc53.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Telegram DocsGPT extension\n\nThis repository contains the source code for a Telegram bot that leverages DocsGPT to provide intelligent responses to user queries. This bot is an extension for [DocsGPT](https://www.docsgpt.cloud/).\n\n## Features\n- Responds to user queries with intelligent answers using DocsGPT.\n- Maintains conversation history for context-aware responses.\n- Easily deployable using Docker.\n\n## Prerequisites\nBefore you begin, ensure you have met the following requirements:\n- You have registered a bot with [BotFather](https://core.telegram.org/bots#botfather) on Telegram and obtained a `TOKEN`.\n- You have created an API key on [DocsGPT](https://www.docsgpt.cloud/) to access your AI's data and prompt.\n\n## Installation\n\n### Using Python\n\n1. Clone the repository:\n    ```bash\n    git clone https://github.com/arc53/tg-bot-docsgpt-extenstion.git\n    cd tg-bot-docsgpt-extenstion\n    ```\n\n2. Set up a virtual environment:\n    ```bash\n    python3 -m venv venv\n    ```\n    - On macOS and Linux:\n      ```bash\n      source venv/bin/activate\n      ```\n    - On Windows:\n      ```bash\n      .\\venv\\Scripts\\activate\n      ```\n\n3. Install dependencies:\n    ```bash\n    pip install -r requirements.txt\n    ```\n\n4. Create a `.env` file in the project directory and add your environment variables:\n    ```plaintext\n    TELEGRAM_BOT_TOKEN=\u003cyour-telegram-bot-token\u003e\n    API_KEY=\u003cyour-api-key\u003e\n    ```\n\n5. Run the bot:\n    ```bash\n    python bot.py\n    ```\n\n### Using Docker\n\n1. Clone the repository:\n    ```bash\n    git clone https://github.com/arc53/tg-bot-docsgpt-extenstion.git\n    cd tg-bot-docsgpt-extenstion\n    ```\n\n2. Build the Docker image:\n    ```bash\n    docker build -t telegram-gpt-bot .\n    ```\n\n3. Create a `.env` file in the project directory and add your environment variables:\n    ```plaintext\n    TELEGRAM_BOT_TOKEN=\u003cyour-telegram-bot-token\u003e\n    API_KEY=\u003cyour-api-key\u003e\n    ```\n\n4. Run the Docker container:\n    ```bash\n    docker run --env-file .env telegram-gpt-bot\n    ```\n\n## Usage\n\n### Telegram Commands\n- `/start` - Initiates the conversation with the bot.\n- `/help` - Provides help information.\n\n### General Conversation\nSimply type any message, and the bot will respond with an intelligent answer based on the context of the conversation maintained in `context.chat_data`.\n\n## File Description\n- `bot.py`: The main script for running the bot.\n- `requirements.txt`: Python dependencies required by the bot.\n- `Dockerfile`: Instructions to build the Docker image.\n- `.env`: File containing environment variables (not included, must be created).\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n- [DocsGPT](https://www.docsgpt.cloud/)\n- [DocsGPT Github](https://github.com/arc53/docsgpt)\n- [Telegram Bot API](https://core.telegram.org/bots/api)\n- [Python Telegram Bot](https://python-telegram-bot.readthedocs.io/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farc53%2Ftg-bot-docsgpt-extenstion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farc53%2Ftg-bot-docsgpt-extenstion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farc53%2Ftg-bot-docsgpt-extenstion/lists"}