Metadata-Version: 2.1
Name: popcatapiwrapper
Version: 0.0.8
Summary: PopCatWrapper is an asynchronous wrapper for https://popcat.xyz/api
Home-page: https://github.com/Infernum1/PopCatWrapper
License: MIT
Author: Infernum1
Requires-Python: >=3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: aiohttp (>=3.7.2,<4.0.0)
Requires-Dist: furo (>=2022.9.29,<2023.0.0)
Project-URL: Repository, https://github.com/Infernum1/PopCatWrapper
Description-Content-Type: text/markdown



An async API wrapper around [popcat-api](https://popcat.xyz/api)


## Project development has been paused till April, 2023
### Get started || [Documentation](https://popcat-api.readthedocs.io/en/latest/)

#### to get started, type this in your terminal
```
pip install -U popcatapiwrapper
```

#### or to install the main branch
```
pip install -U git+https://github.com/Infernum1/PopCatWrapper
```
###### (make sure you have [git](https://gitforwindows.org) installed)
### Examples
#### For a list of examples of each endpoint, take a look at the [examples directory](https://github.com/Infernum1/PopCatWrapper/tree/main/examples)


##### If you plan to use the lib in a discord bot

```py
import discord
import PopCatWrapper

client = PopCatWrapper.PopCatAPI()
bot = discord.ext.commands.Bot()

@bot.command()
async def element(element: str): #you can feed either the atomic number, symbol, or element name
  image = await client.get_element_info(element)
  await ctx.send(content=element.summary)
```

###### these are just examples! it's upto you how you want to use this lib.

### Add `Infernum#7041` on discord for help

#### You're welcome to make a Pull Request if you feel something can be improved :)

