Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/baseplate-admin/libravatar-py
Friendly fork of pyLibravatar for async support.
https://github.com/baseplate-admin/libravatar-py
async avatar httpx libravatar python
Last synced: about 1 month ago
JSON representation
Friendly fork of pyLibravatar for async support.
- Host: GitHub
- URL: https://github.com/baseplate-admin/libravatar-py
- Owner: baseplate-admin
- License: mit
- Created: 2021-12-27T05:44:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T04:09:46.000Z (2 months ago)
- Last Synced: 2024-10-06T10:48:06.761Z (about 1 month ago)
- Topics: async, avatar, httpx, libravatar, python
- Language: Python
- Homepage: https://pypi.org/project/libravatar-py/
- Size: 147 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A libravatar client for Python thats built on modern Technology
[](https://pepy.tech/project/libravatar-py)
[](https://badge.fury.io/py/libravatar-py)
[](https://github.com/baseplate-admin/libravatar-py/blob/main/setup.py)
[](https://github.com/baseplate-admin/libravatar-py/blob/main/LICENSE)
[](https://github.com/baseplate-admin/libravatar-py)
## Introduction :
Friendly fork of [pyLibravatar](https://launchpad.net/pylibravatar).
### Why did I write this library:
While working on the Libravatar client project I came across the well built [pyLibravatar](https://pypi.org/project/pyLibravatar) library. The last update was at Jun 28, 2015 ( Thats over 6 years ago when I was writing this ). So thats why I decided to write this library. It mimics the API ( and functionality ) of [pyLibravatar](https://pypi.org/project/pyLibravatar) but with `asyncio` spice.
### Why use \"libravatar-py\" ?
- Provides API for different kinds of usage.
- Built with modern techknology.
- No unnecessary codes. ( My goal was to keep the library as small as
possible )
- Is very minimal. ( Only provides 4 functions )
- Fully Fedarated and feature rich.
### Why shouldn\'t you use \"libravatar-py\" ?
- I donno ? If you do please submit a Pull Request
# User guide :
## Installation :
Install with pip from pypi (No extra dependencies):
```bash
$ python -m pip install libravatar-py
```
Install with pip from github ( Development | Not Recommended for Production ):
```bash
$ python -m pip install https://codeload.github.com/baseplate-admin/libravatar-py/zip/refs/heads/main
```
## Usage:
Call any of these 4 methods.
`libravatar_url` function ( This will essentially return the base url of
the image ) :
```python
from libravatar import libravatar_url
url = libravatar_url(email="[email protected]")
print(url)
# https://seccdn.libravatar.org/avatar/16d113840f999444259f73bac9ab8b10
```
`libravatar_img_tag` function ( This will wrap the libravatar url in a \![]()
tag. You can also customize \_alt text ) :
```python
from libravatar import libravatar_img_tag
url = libravatar_img_tag(email="[email protected]")
print(url)
# 
```
`libravatar_raw_image` function ( This will return the Libravatar image in a binary form ) :
``` python
from libravatar import libravatar_raw_image
res = libravatar_raw_image(email="[email protected]")
print(res)
# Large binary string.
# To load it.
from PIL import Image
from io import BytesIO
res = Image.open(BytesIO(res))
```
`libravatar_raw_query` function ( Essentially passes the {args, kwargs} to httpx_get_avatar ):
``` python
from libravatar import libravatar_raw_image
# Note this this must be called from an async function
res = await libravatar_raw_query(email="[email protected]", {})
# All httpx variables available in res
```
# Contributing :
If you like this project add a star. If you have problems or suggestions please put them in the [Issue Tracker](https://github.com/baseplate-admin/libravatar-py/issues). If
you like to add features. Fork this repo and submit a Pull Request. 😛
# Updates :
The library is feature complete ( in my opinion ).