| Name | copilot-api JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | An unofficial Python API wrapper for Microsoft Copilot |
| upload_time | 2024-11-22 08:23:42 |
| maintainer | None |
| docs_url | None |
| author | OEvortex |
| requires_python | >=3.7 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🤖 Copilot API
<div align="center">
[](https://badge.fury.io/py/copilot-api)
[](https://pypi.org/project/copilot-api/)
[](https://github.com/OE-LUCIFER/copilot-api/blob/main/LICENSE)
[](https://github.com/OE-LUCIFER/copilot-api/stargazers)
[](https://pepy.tech/project/copilot-api)
[](https://pepy.tech/project/copilot-api)
[](https://pepy.tech/project/copilot-api)
[](https://github.com/OE-LUCIFER/copilot-api/commits/main)
[](https://github.com/psf/black)
[](https://github.com/OE-LUCIFER/copilot-api/issues)
<p align="center">
<strong>🚀 A powerful, unofficial Python API wrapper for Microsoft Copilot with CLI support</strong>
</p>
[Installation](#-installation) •
[Features](#-features) •
[Quick Start](#-quick-start) •
[CLI Usage](#-cli-usage) •
[Examples](#-examples) •
[Contributing](#-contributing) •
[Support](#-support)
</div>
## ⭐ Stargazers
<div align="center">
[](https://github.com/OE-LUCIFER/copilot-api/stargazers)
</div>
## 📦 Installation
```bash
# Using pip
pip install copilot-api
# From source
git clone https://github.com/OE-LUCIFER/copilot-api.git
cd copilot-api
pip install -e .
```
## 🎯 Key Features
- 🤖 **Microsoft Copilot Integration** - Direct access to Microsoft Copilot's capabilities
- 🔄 **Streaming Support** - Real-time response streaming for better interactivity
- 🛡️ **Robust Error Handling** - Comprehensive exception handling with custom error types
- 🔌 **Flexible Configuration** - Support for proxies, timeouts, and custom settings
- 🎨 **Rich CLI Interface** - Interactive terminal experience with syntax highlighting
- 📦 **Lightweight & Fast** - Minimal dependencies with efficient implementation
## ✨ Features
### Core Features
- 🔄 **Stream Chat Completions** - Real-time streaming responses
- 💬 **Conversation Management** - Maintain context across messages
- 🔒 **Proxy Support** - Configure custom proxy settings
- ⚙️ **Customizable** - Flexible timeout and configuration options
### CLI Features
- 🎨 **Rich Text Interface** - Beautiful terminal UI with syntax highlighting
- 📝 **Interactive Chat** - Full-featured chat interface in your terminal
- 💾 **Session Management** - Save and load conversation sessions
- 🎯 **Multiple Commands** - Dedicated commands for different functionalities
- 🔍 **Help System** - Built-in help and documentation
### Developer Features
- 🛠️ **Type Hints** - Full type annotation support
- 📚 **Rich Documentation** - Comprehensive API documentation
- 🧪 **Exception Handling** - Detailed error messages and handling
- 🔌 **Extensible** - Easy to extend and customize
- 🎮 **Multiple Interfaces** - Use as library or CLI tool
## 🔧 Technical Details
### Core Components
- `copilot.py` - Main Copilot client implementation
- `cli.py` - Command-line interface implementation
- `exceptions.py` - Custom exception definitions
- `utils.py` - Helper functions and utilities
### Error Handling
The library includes custom exceptions for better error management:
```python
from copilot_api.exceptions import CopilotError, AuthenticationError, APIError
try:
response = copilot.create_completion(messages=messages)
except AuthenticationError:
print("Authentication failed. Please check your credentials.")
except APIError as e:
print(f"API error occurred: {e}")
```
## 🚀 Quick Start
### Python Library Usage
```python
from copilot_api import Copilot
# Initialize Copilot
copilot = Copilot()
# Basic chat example
messages = [
{"role": "system", "content": "You are a helpful AI assistant."},
{"role": "user", "content": "Hello!"}
]
# Stream responses
for response in copilot.create_completion(
model="Copilot",
messages=messages,
stream=True
):
if isinstance(response, str):
print(response, end='', flush=True)
```
## 🖥️ CLI Usage
### Interactive Chat
```bash
# Start interactive chat
copilot-cli
# Start chat with specific model
copilot-cli --model Copilot
# Save conversation
copilot-cli --save chat_history.json
# Load previous conversation
copilot-cli --load chat_history.json
```
### Alternative Usage
```bash
# Using Python module directly
python -m copilot_api.cli chat
# Or using the main command
copilot chat
```
### CLI Commands
- `/help` - Show help message
- `/clear` - Clear current conversation
- `/save <filename>` - Save conversation
- `/load <filename>` - Load conversation
- `/exit` - Exit the CLI
## 📚 Examples
### 💬 Managing Conversations
```python
from copilot_api import save_conversation, load_conversation
# Save conversation
save_conversation("chat_history.json", messages)
# Load conversation
messages = load_conversation("chat_history.json")
```
## 🛠️ Advanced Usage
### Proxy Configuration
```python
copilot = Copilot(
proxy="http://your-proxy-server:port"
)
```
### Custom Timeout Settings
```python
copilot = Copilot(
timeout=30 # seconds
)
```
### Advanced Configuration
```python
from copilot_api import Copilot
# Initialize with custom configuration
copilot = Copilot(
timeout=30,
proxy="http://proxy:port",
max_retries=3,
verify_ssl=True
)
# Custom headers and parameters
response = copilot.create_completion(
messages=[{"role": "user", "content": "Hello!"}],
stream=True,
temperature=0.7,
max_tokens=150
)
```
### CLI Features
The CLI tool (`copilot-cli`) supports various commands and options:
```bash
# Start with custom configuration
copilot-cli --timeout 30 --no-stream
# Export conversation
copilot-cli --export chat.json
# Import and continue conversation
copilot-cli --import chat.json
```
Available CLI commands:
- `/system <message>` - Set system message
- `/model <name>` - Change model
- `/retry` - Retry last message
- `/tokens` - Show token count
- `/version` - Show version info
## 🔍 Debugging
Enable debug mode for detailed logging:
```python
import logging
logging.basicConfig(level=logging.DEBUG)
copilot = Copilot(debug=True)
```
## 🧪 Testing
Run the test suite:
```bash
# Install test dependencies
pip install -e ".[test]"
# Run tests with coverage
pytest --cov=copilot_api tests/
```
## 📋 Requirements
- Python 3.7+
- Core Dependencies:
- `requests>=2.25.0`
- `websockets>=10.0`
- `aiohttp>=3.8.0`
- `python-dotenv>=0.19.0`
- `tls-client>=0.2.0`
- `beautifulsoup4>=4.9.3`
- CLI Dependencies:
- `click>=8.0.0`
- `rich>=10.0.0`
- `prompt-toolkit>=3.0.0`
## 🤝 Contributing
Contributions are welcome! Here's how you can help:
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
### Development Setup
```bash
# Clone the repository
git clone https://github.com/OE-LUCIFER/copilot-api.git
# Install development dependencies
pip install -e ".[dev]"
# Run tests
pytest
```
## 📝 License
This project is licensed under the HelpingAI License - see the [LICENSE](LICENSE) file for details.
The HelpingAI License is a proprietary license that grants specific rights while protecting HelpingAI's intellectual property. Please read the license carefully before using this software.
## 🌟 Support
- Star this repository
- Follow [@OEvortex](https://youtube.com/@OEvortex) on YouTube
- Report issues on our [Issue Tracker](https://github.com/OE-LUCIFER/copilot-api/issues)
- Consider [sponsoring](https://github.com/sponsors/OE-LUCIFER) the project
## 📊 Project Stats
## 📈 Star History
<div align="center">
[](https://star-history.com/#OE-LUCIFER/copilot-api&Date)
</div>
---
<div align="center">
<sub>Built with ❤️ by <a href="https://github.com/OE-LUCIFER">OEvortex</a></sub>
</div>
Raw data
{
"_id": null,
"home_page": null,
"name": "copilot-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "OEvortex",
"author_email": "helpingai5@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d8/bb/a20b013ed3d5fba5ef067d07fa9a9b6cc8eb8fbf88c7d648d7592b63bf40/copilot_api-1.0.0.tar.gz",
"platform": null,
"description": "# \ud83e\udd16 Copilot API\r\n\r\n<div align=\"center\">\r\n\r\n[](https://badge.fury.io/py/copilot-api)\r\n[](https://pypi.org/project/copilot-api/)\r\n[](https://github.com/OE-LUCIFER/copilot-api/blob/main/LICENSE)\r\n[](https://github.com/OE-LUCIFER/copilot-api/stargazers)\r\n[](https://pepy.tech/project/copilot-api)\r\n[](https://pepy.tech/project/copilot-api)\r\n[](https://pepy.tech/project/copilot-api)\r\n[](https://github.com/OE-LUCIFER/copilot-api/commits/main)\r\n[](https://github.com/psf/black)\r\n[](https://github.com/OE-LUCIFER/copilot-api/issues)\r\n\r\n<p align=\"center\">\r\n <strong>\ud83d\ude80 A powerful, unofficial Python API wrapper for Microsoft Copilot with CLI support</strong>\r\n</p>\r\n\r\n[Installation](#-installation) \u2022\r\n[Features](#-features) \u2022\r\n[Quick Start](#-quick-start) \u2022\r\n[CLI Usage](#-cli-usage) \u2022\r\n[Examples](#-examples) \u2022\r\n[Contributing](#-contributing) \u2022\r\n[Support](#-support)\r\n\r\n</div>\r\n\r\n\r\n## \u2b50 Stargazers\r\n\r\n<div align=\"center\">\r\n \r\n[](https://github.com/OE-LUCIFER/copilot-api/stargazers)\r\n\r\n</div>\r\n\r\n## \ud83d\udce6 Installation\r\n\r\n```bash\r\n# Using pip\r\npip install copilot-api\r\n\r\n# From source\r\ngit clone https://github.com/OE-LUCIFER/copilot-api.git\r\ncd copilot-api\r\npip install -e .\r\n```\r\n\r\n## \ud83c\udfaf Key Features\r\n\r\n- \ud83e\udd16 **Microsoft Copilot Integration** - Direct access to Microsoft Copilot's capabilities\r\n- \ud83d\udd04 **Streaming Support** - Real-time response streaming for better interactivity\r\n- \ud83d\udee1\ufe0f **Robust Error Handling** - Comprehensive exception handling with custom error types\r\n- \ud83d\udd0c **Flexible Configuration** - Support for proxies, timeouts, and custom settings\r\n- \ud83c\udfa8 **Rich CLI Interface** - Interactive terminal experience with syntax highlighting\r\n- \ud83d\udce6 **Lightweight & Fast** - Minimal dependencies with efficient implementation\r\n\r\n## \u2728 Features\r\n\r\n### Core Features\r\n- \ud83d\udd04 **Stream Chat Completions** - Real-time streaming responses\r\n- \ud83d\udcac **Conversation Management** - Maintain context across messages\r\n- \ud83d\udd12 **Proxy Support** - Configure custom proxy settings\r\n- \u2699\ufe0f **Customizable** - Flexible timeout and configuration options\r\n\r\n### CLI Features\r\n- \ud83c\udfa8 **Rich Text Interface** - Beautiful terminal UI with syntax highlighting\r\n- \ud83d\udcdd **Interactive Chat** - Full-featured chat interface in your terminal\r\n- \ud83d\udcbe **Session Management** - Save and load conversation sessions\r\n- \ud83c\udfaf **Multiple Commands** - Dedicated commands for different functionalities\r\n- \ud83d\udd0d **Help System** - Built-in help and documentation\r\n\r\n### Developer Features\r\n- \ud83d\udee0\ufe0f **Type Hints** - Full type annotation support\r\n- \ud83d\udcda **Rich Documentation** - Comprehensive API documentation\r\n- \ud83e\uddea **Exception Handling** - Detailed error messages and handling\r\n- \ud83d\udd0c **Extensible** - Easy to extend and customize\r\n- \ud83c\udfae **Multiple Interfaces** - Use as library or CLI tool\r\n\r\n## \ud83d\udd27 Technical Details\r\n\r\n### Core Components\r\n\r\n- `copilot.py` - Main Copilot client implementation\r\n- `cli.py` - Command-line interface implementation\r\n- `exceptions.py` - Custom exception definitions\r\n- `utils.py` - Helper functions and utilities\r\n\r\n### Error Handling\r\n\r\nThe library includes custom exceptions for better error management:\r\n```python\r\nfrom copilot_api.exceptions import CopilotError, AuthenticationError, APIError\r\n\r\ntry:\r\n response = copilot.create_completion(messages=messages)\r\nexcept AuthenticationError:\r\n print(\"Authentication failed. Please check your credentials.\")\r\nexcept APIError as e:\r\n print(f\"API error occurred: {e}\")\r\n```\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n### Python Library Usage\r\n\r\n```python\r\nfrom copilot_api import Copilot\r\n\r\n# Initialize Copilot\r\ncopilot = Copilot()\r\n\r\n# Basic chat example\r\nmessages = [\r\n {\"role\": \"system\", \"content\": \"You are a helpful AI assistant.\"},\r\n {\"role\": \"user\", \"content\": \"Hello!\"}\r\n]\r\n\r\n# Stream responses\r\nfor response in copilot.create_completion(\r\n model=\"Copilot\",\r\n messages=messages,\r\n stream=True\r\n):\r\n if isinstance(response, str):\r\n print(response, end='', flush=True)\r\n```\r\n\r\n## \ud83d\udda5\ufe0f CLI Usage\r\n\r\n### Interactive Chat\r\n\r\n```bash\r\n# Start interactive chat\r\ncopilot-cli\r\n\r\n# Start chat with specific model\r\ncopilot-cli --model Copilot\r\n\r\n# Save conversation\r\ncopilot-cli --save chat_history.json\r\n\r\n# Load previous conversation\r\ncopilot-cli --load chat_history.json\r\n```\r\n\r\n### Alternative Usage\r\n```bash\r\n# Using Python module directly\r\npython -m copilot_api.cli chat\r\n\r\n# Or using the main command\r\ncopilot chat\r\n```\r\n\r\n### CLI Commands\r\n- `/help` - Show help message\r\n- `/clear` - Clear current conversation\r\n- `/save <filename>` - Save conversation\r\n- `/load <filename>` - Load conversation\r\n- `/exit` - Exit the CLI\r\n\r\n## \ud83d\udcda Examples\r\n\r\n### \ud83d\udcac Managing Conversations\r\n\r\n```python\r\nfrom copilot_api import save_conversation, load_conversation\r\n\r\n# Save conversation\r\nsave_conversation(\"chat_history.json\", messages)\r\n\r\n# Load conversation\r\nmessages = load_conversation(\"chat_history.json\")\r\n```\r\n\r\n## \ud83d\udee0\ufe0f Advanced Usage\r\n\r\n### Proxy Configuration\r\n```python\r\ncopilot = Copilot(\r\n proxy=\"http://your-proxy-server:port\"\r\n)\r\n```\r\n\r\n### Custom Timeout Settings\r\n```python\r\ncopilot = Copilot(\r\n timeout=30 # seconds\r\n)\r\n```\r\n\r\n### Advanced Configuration\r\n\r\n```python\r\nfrom copilot_api import Copilot\r\n\r\n# Initialize with custom configuration\r\ncopilot = Copilot(\r\n timeout=30,\r\n proxy=\"http://proxy:port\",\r\n max_retries=3,\r\n verify_ssl=True\r\n)\r\n\r\n# Custom headers and parameters\r\nresponse = copilot.create_completion(\r\n messages=[{\"role\": \"user\", \"content\": \"Hello!\"}],\r\n stream=True,\r\n temperature=0.7,\r\n max_tokens=150\r\n)\r\n```\r\n\r\n### CLI Features\r\n\r\nThe CLI tool (`copilot-cli`) supports various commands and options:\r\n\r\n```bash\r\n# Start with custom configuration\r\ncopilot-cli --timeout 30 --no-stream\r\n\r\n# Export conversation\r\ncopilot-cli --export chat.json\r\n\r\n# Import and continue conversation\r\ncopilot-cli --import chat.json\r\n```\r\n\r\nAvailable CLI commands:\r\n- `/system <message>` - Set system message\r\n- `/model <name>` - Change model\r\n- `/retry` - Retry last message\r\n- `/tokens` - Show token count\r\n- `/version` - Show version info\r\n\r\n## \ud83d\udd0d Debugging\r\n\r\nEnable debug mode for detailed logging:\r\n\r\n```python\r\nimport logging\r\nlogging.basicConfig(level=logging.DEBUG)\r\n\r\ncopilot = Copilot(debug=True)\r\n```\r\n\r\n## \ud83e\uddea Testing\r\n\r\nRun the test suite:\r\n\r\n```bash\r\n# Install test dependencies\r\npip install -e \".[test]\"\r\n\r\n# Run tests with coverage\r\npytest --cov=copilot_api tests/\r\n```\r\n\r\n## \ud83d\udccb Requirements\r\n\r\n- Python 3.7+\r\n- Core Dependencies:\r\n - `requests>=2.25.0`\r\n - `websockets>=10.0`\r\n - `aiohttp>=3.8.0`\r\n - `python-dotenv>=0.19.0`\r\n - `tls-client>=0.2.0`\r\n - `beautifulsoup4>=4.9.3`\r\n- CLI Dependencies:\r\n - `click>=8.0.0`\r\n - `rich>=10.0.0`\r\n - `prompt-toolkit>=3.0.0`\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nContributions are welcome! Here's how you can help:\r\n\r\n1. Fork the repository\r\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\r\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\r\n4. Push to the branch (`git push origin feature/amazing-feature`)\r\n5. Open a Pull Request\r\n\r\n### Development Setup\r\n\r\n```bash\r\n# Clone the repository\r\ngit clone https://github.com/OE-LUCIFER/copilot-api.git\r\n\r\n# Install development dependencies\r\npip install -e \".[dev]\"\r\n\r\n# Run tests\r\npytest\r\n```\r\n\r\n## \ud83d\udcdd License\r\n\r\nThis project is licensed under the HelpingAI License - see the [LICENSE](LICENSE) file for details.\r\n\r\nThe HelpingAI License is a proprietary license that grants specific rights while protecting HelpingAI's intellectual property. Please read the license carefully before using this software.\r\n\r\n## \ud83c\udf1f Support\r\n\r\n- Star this repository\r\n- Follow [@OEvortex](https://youtube.com/@OEvortex) on YouTube\r\n- Report issues on our [Issue Tracker](https://github.com/OE-LUCIFER/copilot-api/issues)\r\n- Consider [sponsoring](https://github.com/sponsors/OE-LUCIFER) the project\r\n\r\n## \ud83d\udcca Project Stats\r\n\r\n![Alt](https://repobeats.axiom.co/api/embed/ff8173c0c516e81b66502ce32e1b386dd3da2fdc.svg \"Repobeats analytics image\")\r\n\r\n## \ud83d\udcc8 Star History\r\n\r\n<div align=\"center\">\r\n\r\n[](https://star-history.com/#OE-LUCIFER/copilot-api&Date)\r\n\r\n</div>\r\n\r\n---\r\n\r\n<div align=\"center\">\r\n <sub>Built with \u2764\ufe0f by <a href=\"https://github.com/OE-LUCIFER\">OEvortex</a></sub>\r\n</div>\r\n",
"bugtrack_url": null,
"license": null,
"summary": "An unofficial Python API wrapper for Microsoft Copilot",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/OE-LUCIFER/copilot-api/issues",
"Homepage": "https://github.com/OE-LUCIFER/copilot-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2b2f8ffe5140d515de4c83563912b9fdc37aca4a913f7ba1d489d52211cd3f7",
"md5": "6f7c7ee6dff846de639afcdc0434b27d",
"sha256": "bff850f6b8ce4933cee4867f3316e4f79800c12aec933311782870e08846334b"
},
"downloads": -1,
"filename": "copilot_api-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f7c7ee6dff846de639afcdc0434b27d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 16625,
"upload_time": "2024-11-22T08:23:39",
"upload_time_iso_8601": "2024-11-22T08:23:39.683361Z",
"url": "https://files.pythonhosted.org/packages/a2/b2/f8ffe5140d515de4c83563912b9fdc37aca4a913f7ba1d489d52211cd3f7/copilot_api-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8bba20b013ed3d5fba5ef067d07fa9a9b6cc8eb8fbf88c7d648d7592b63bf40",
"md5": "d655b94acd7e25bf17d8b741916059f9",
"sha256": "8838366c5101240922a7bb17a40e8912944d41cbe9733830744b32e5d93d2bb6"
},
"downloads": -1,
"filename": "copilot_api-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d655b94acd7e25bf17d8b741916059f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 18873,
"upload_time": "2024-11-22T08:23:42",
"upload_time_iso_8601": "2024-11-22T08:23:42.319478Z",
"url": "https://files.pythonhosted.org/packages/d8/bb/a20b013ed3d5fba5ef067d07fa9a9b6cc8eb8fbf88c7d648d7592b63bf40/copilot_api-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 08:23:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OE-LUCIFER",
"github_project": "copilot-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "copilot-api"
}
