<h1 align="center">
anvolt.py
</h1>
<h3 align="center">
Advanced tool with API integration and additional features
</h2>
<p align="center">
<a href="https://codeclimate.com/github/Stawa/anvolt.py/maintainability"><img src="https://api.codeclimate.com/v1/badges/780b1926cc1affa10cf4/maintainability"></a>
<a href="https://pypi.org/project/anvolt.py"><img src="https://img.shields.io/pypi/pyversions/anvolt.py"><a>
<a href="https://github.com/psf/black"><img src="https://img.shields.io/static/v1?label=code style&message=black&color=black"></a>
<a href="https://pepy.tech/project/anvolt.py"><img src="https://static.pepy.tech/badge/anvolt-py/month"/></a>
<a href="https://img.shields.io/pypi/l/anvolt.py?color=informational"><img src="https://img.shields.io/pypi/l/anvolt.py?color=informational"></a>
</p>
### <span class="emoji">✨</span> Features
Explore the vast array of features available in **[anvolt.py](https://anvolt.vercel.app/api/)** with this comprehensive list:
- **Roleplaying Images**: Add high-quality images for immersive roleplaying experiences
- **Quizzes / Trivia**: Incorporate interactive quizzes and trivia games to engage users
- **Anime Images (SFW / NSFW)**: Include a variety of anime-related images, including both safe-for-work and not-safe-for-work options
- **Client-Side Support**: Provide support for client-side implementation, allowing for seamless integration with existing projects
- **Ease-of-Use Codes**: Design the package with simplicity and ease-of-use in mind, offering user-friendly codes and documentation
- **Twitch API Integration**: Utilize the Twitch API to retrieve and display real-time data from Twitch streams
- **Command-Line Interface**: Include a Command-Line Interface (CLI) for user-friendly access and control of the package's features
### <span class="emoji">📦</span> Installation
There are two ways to install **[anvolt.py](https://anvolt.vercel.app/api/)**, first you can use the stable release from PyPI:
```bash
$ pip install anvolt.py
```
Second you can use the development version from GitHub to get the latest features and updates:
```bash
$ pip install git+https://github.com/Stawa/anvolt.py
```
For more information on how to use the package, check out the **[documentation](https://anvolt.vercel.app/docs/)**
### <span class="emoji"> 🚀 </span> Quickstart
Every function will have its own response class, for example bite function, it return `Responses` class that you can find on `anvolt.models.response`
```py
from anvolt import AnVoltClient
client = AnVoltClient() # client_id and client_secret (optional)
def example():
bite = client.sfw.bite()
print(bite.url) # Return str
example()
```
### <span class="emoji"> 🛠️ </span> Updater
Stay on top of updates and avoid potential errors by using our Updater class. This class ensures you are always using the latest stable version of our API, so you can focus on building your application without worrying about potential changes or bugs.
```py
from anvolt.updater import Updater
updater = Updater()
updater.check_for_updates()
```
### <span class="emoji">💻</span> CLI / Command-Line Interface
The anvolt package provides a Command-Line Interface (CLI) for easy access to its features. To test requests and retrieve a list of endpoints for a specific category, use the following commands:
```bash
$ anvolt category-help
```
This command displays a list of available categories and their respective endpoints. It allows users to see the different categories available and the endpoints associated with each one.
```bash
$ anvolt requests --category <category> --endpoint <endpoint>
```
This command will execute a test request to the specified endpoint in the chosen category. The `--category` and `--endpoint` options are required for this command to work properly.
```
$ anvolt save --category <category> --endpoint <endpoint>
```
This command retrieves an image from the API and saves it to the current directory set in the command prompt, such as `C:\Users\Stawa\Desktop\Folder`
### <span class="emoji">🔗</span> Links
- **[Documentation](https://anvolt.vercel.app/docs/)**
- **[Homepage](https://github.com/Stawa/anvolt.py)**
- **[Application Programming Interface](https://anvolt.vercel.app/api/)**
Raw data
{
"_id": null,
"home_page": "https://anvolt.vercel.app/api/",
"name": "anvolt.py",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "api,anime,games,roleplay,images,trivia,discord,webhooks,twitch",
"author": "Stawa",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c0/21/fb7d19651e768f7a3a5eda59412328400e3984f81f180aa10050691322a3/anvolt.py-0.1.6.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\r\n anvolt.py\r\n</h1>\r\n\r\n<h3 align=\"center\">\r\n Advanced tool with API integration and additional features\r\n</h2>\r\n\r\n<p align=\"center\">\r\n <a href=\"https://codeclimate.com/github/Stawa/anvolt.py/maintainability\"><img src=\"https://api.codeclimate.com/v1/badges/780b1926cc1affa10cf4/maintainability\"></a>\r\n <a href=\"https://pypi.org/project/anvolt.py\"><img src=\"https://img.shields.io/pypi/pyversions/anvolt.py\"><a>\r\n <a href=\"https://github.com/psf/black\"><img src=\"https://img.shields.io/static/v1?label=code style&message=black&color=black\"></a>\r\n <a href=\"https://pepy.tech/project/anvolt.py\"><img src=\"https://static.pepy.tech/badge/anvolt-py/month\"/></a>\r\n <a href=\"https://img.shields.io/pypi/l/anvolt.py?color=informational\"><img src=\"https://img.shields.io/pypi/l/anvolt.py?color=informational\"></a>\r\n</p>\r\n\r\n### <span class=\"emoji\">\u2728</span> Features\r\n\r\nExplore the vast array of features available in **[anvolt.py](https://anvolt.vercel.app/api/)** with this comprehensive list:\r\n\r\n- **Roleplaying Images**: Add high-quality images for immersive roleplaying experiences\r\n- **Quizzes / Trivia**: Incorporate interactive quizzes and trivia games to engage users\r\n- **Anime Images (SFW / NSFW)**: Include a variety of anime-related images, including both safe-for-work and not-safe-for-work options\r\n- **Client-Side Support**: Provide support for client-side implementation, allowing for seamless integration with existing projects\r\n- **Ease-of-Use Codes**: Design the package with simplicity and ease-of-use in mind, offering user-friendly codes and documentation\r\n- **Twitch API Integration**: Utilize the Twitch API to retrieve and display real-time data from Twitch streams\r\n- **Command-Line Interface**: Include a Command-Line Interface (CLI) for user-friendly access and control of the package's features\r\n\r\n### <span class=\"emoji\">\ud83d\udce6</span> Installation\r\n\r\nThere are two ways to install **[anvolt.py](https://anvolt.vercel.app/api/)**, first you can use the stable release from PyPI:\r\n\r\n```bash\r\n$ pip install anvolt.py\r\n```\r\n\r\nSecond you can use the development version from GitHub to get the latest features and updates:\r\n\r\n```bash\r\n$ pip install git+https://github.com/Stawa/anvolt.py\r\n```\r\n\r\nFor more information on how to use the package, check out the **[documentation](https://anvolt.vercel.app/docs/)**\r\n\r\n### <span class=\"emoji\"> \ud83d\ude80 </span> Quickstart\r\n\r\nEvery function will have its own response class, for example bite function, it return `Responses` class that you can find on `anvolt.models.response`\r\n\r\n```py\r\nfrom anvolt import AnVoltClient\r\n\r\nclient = AnVoltClient() # client_id and client_secret (optional)\r\n\r\ndef example():\r\n bite = client.sfw.bite()\r\n print(bite.url) # Return str\r\n\r\nexample()\r\n```\r\n\r\n### <span class=\"emoji\"> \ud83d\udee0\ufe0f </span> Updater\r\n\r\nStay on top of updates and avoid potential errors by using our Updater class. This class ensures you are always using the latest stable version of our API, so you can focus on building your application without worrying about potential changes or bugs.\r\n\r\n```py\r\nfrom anvolt.updater import Updater\r\n\r\nupdater = Updater()\r\nupdater.check_for_updates()\r\n```\r\n\r\n### <span class=\"emoji\">\ud83d\udcbb</span> CLI / Command-Line Interface\r\n\r\nThe anvolt package provides a Command-Line Interface (CLI) for easy access to its features. To test requests and retrieve a list of endpoints for a specific category, use the following commands:\r\n\r\n```bash\r\n$ anvolt category-help\r\n```\r\n\r\nThis command displays a list of available categories and their respective endpoints. It allows users to see the different categories available and the endpoints associated with each one.\r\n\r\n```bash\r\n$ anvolt requests --category <category> --endpoint <endpoint>\r\n```\r\n\r\nThis command will execute a test request to the specified endpoint in the chosen category. The `--category` and `--endpoint` options are required for this command to work properly.\r\n\r\n```\r\n$ anvolt save --category <category> --endpoint <endpoint>\r\n```\r\n\r\nThis command retrieves an image from the API and saves it to the current directory set in the command prompt, such as `C:\\Users\\Stawa\\Desktop\\Folder`\r\n\r\n### <span class=\"emoji\">\ud83d\udd17</span> Links\r\n\r\n- **[Documentation](https://anvolt.vercel.app/docs/)**\r\n- **[Homepage](https://github.com/Stawa/anvolt.py)**\r\n- **[Application Programming Interface](https://anvolt.vercel.app/api/)**\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Advanced tool with API integration and additional features",
"version": "0.1.6",
"split_keywords": [
"api",
"anime",
"games",
"roleplay",
"images",
"trivia",
"discord",
"webhooks",
"twitch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c021fb7d19651e768f7a3a5eda59412328400e3984f81f180aa10050691322a3",
"md5": "3edb8bc705aba4b46b652fe2f246d35f",
"sha256": "c1cfb56e2280cf139c137889c80096ea859610dca583d898c5956dcb63f1e782"
},
"downloads": -1,
"filename": "anvolt.py-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "3edb8bc705aba4b46b652fe2f246d35f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13567,
"upload_time": "2023-01-25T13:47:15",
"upload_time_iso_8601": "2023-01-25T13:47:15.421162Z",
"url": "https://files.pythonhosted.org/packages/c0/21/fb7d19651e768f7a3a5eda59412328400e3984f81f180aa10050691322a3/anvolt.py-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-25 13:47:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "anvolt.py"
}
JSON