Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/weilbyte/pfp_lgbt.py

Python API Wrapper for https://pfp.lgbt/
https://github.com/weilbyte/pfp_lgbt.py

Last synced: 10 days ago
JSON representation

Python API Wrapper for https://pfp.lgbt/

Awesome Lists containing this project

README

        

# pfp_lgbt.py

![Master](https://github.com/Weilbyte/pfp_lgbt.py/workflows/CI/badge.svg?branch=master) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/d0da4cffcb744674a69fbcee8253796d)](https://www.codacy.com/manual/Weilbyte/pfp_lgbt.py?utm_source=github.com&utm_medium=referral&utm_content=Weilbyte/pfp_lgbt.py&utm_campaign=Badge_Grade)

Asynchronous Python API Wrapper for https://pfp.lgbt/
Respects rate limits.

### Installing

To install the library you can run the following command
```py
pip3 install pfp_lgbt
```

### Documentation
You can find the documentation on this repo's wiki.

### Examples
List the names of all available flags.
```py
import pfp_lgbt

async def example():
client = pfp_lgbt.Client()
flags = await client.flags()
for flag in flags:
print(flag.name)
await client.close()
```

Create a static image from URL, and manually save the bytes as file
```py
import pfp_lgbt

async def example():
client = pfp_lgbt.Client()
flag = pfp_lgbt.Flag(name='nb') # Non-binary flag

# `Result` becomes bytes of result image
result = await client.imageStatic('https://i.imgur.com/Ypw5pca.png', 'square', 'solid', flag)

with open('result.png', 'wb') as resfile:
resfile.write(result)

await client.close()
```

Create animated image from URL, and save it to output file
```py
import pfp_lgbt

async def example():
client = pfp_lgbt.Client()
flag = pfp_lgbt.Flag(name='nb') # Non-binary flag
_ = await client.imageAnimated('https://i.imgur.com/Ypw5pca.png', 'square', flag, output_file='output.gif')
client = await client.close()
```