https://github.com/physicistsouravdas/dj-gravatar
Use Gravatar in Django Website
https://github.com/physicistsouravdas/dj-gravatar
django django-application gravatar hacktoberfest hacktoberfest2021 python
Last synced: 6 months ago
JSON representation
Use Gravatar in Django Website
- Host: GitHub
- URL: https://github.com/physicistsouravdas/dj-gravatar
- Owner: PhysicistSouravDas
- License: mit
- Created: 2020-11-18T18:12:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-31T18:23:34.000Z (almost 4 years ago)
- Last Synced: 2025-04-17T14:13:39.997Z (7 months ago)
- Topics: django, django-application, gravatar, hacktoberfest, hacktoberfest2021, python
- Language: Python
- Homepage: https://pypi.org/project/dj-gravatar/
- Size: 2.77 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Dj-Gravatar][Dj-Gravatar repo]
[](https://pypi.org/project/dj-gravatar)
**Dj-Gravatar** is a Python package to display avatars using [Gravatar](https://en.gravatar.com/ "Visit Gravatar Website") on a website developed using Django Framework.
## Installation
### Windows OS
In the terminal/PowerShell, type
```bash
python -m pip install dj-gravatar
```
If you do not have `pip`, then download the package from [here][GitHub zip], unzip it and keep it in your Django project's root directory (as an app).
### Linux/MacOS
In the terminal, type
```bash
sudo pip3 install dj-gravatar
```
If you are in a virtual environment, type
```bash
pip install dj-gravatar
```
If you do not have `pip`, then download the package from [here][GitHub zip], unzip it and keep it in your Django project's root directory (as an app).
## Usage
Suppose the directory structure of your project is like this.
```bash
Django_Project
│ db.sqlite3
│ manage.py
│
├───pages
│ │ admin.py
│ │ apps.py
│ │ models.py
│ │ tests.py
│ │ urls.py
│ │ views.py
│ │ __init__.py
│ └───templates
│ │ base.html
│ │
│ └───pages
│ about.html
│ index.html
│
└───Django_Project
asgi.py
settings.py
urls.py
wsgi.py
__init__.py
```
In `Django_Project/settings.py`,
```python
...
INSTALLED_APPS = [
...
'dj_gravatar' # NOTE: underscore(_) is used instead of hyphen(-)
...
]
...
```
In the Django Template (`.html` file) where you want to show the gravatar,
```html
{% load gravatar %}
...
...
```
The above code outputs like this:
```html
```
The argument `s=200` represents the size of the image (`size=200px`). Default size is 80px.
You can also use the following snippet to achieve the same as above:
```html
{% load gravatar %}
...
{% gravatar 'email@mail' 200 "alt='profile-pic'" %}
...
```
You can use any HTML attribute instead of `alt`, like `style`. But only use one optional attribute at a time, Otherwise you will get `TemplateSyntaxError`.
If you want to use `https://.../` instead of the default `http://.../`, then add the following setting in your `settings.py` file.
```python
GRAVATAR_SECURE = True # Default False
```
If any email address has no matching Gravatar image, then, a default image is shown. There are the following types of default images:
* **404:** do not load any image if none is associated with the email hash, instead return an HTTP 404 (File Not Found) response
* **mp:** (mystery-person) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)
* **identicon:** a geometric pattern based on an email hash
* **monsterid:** a generated 'monster' with different colors, faces, etc
* **wavatar:** generated faces with differing features and backgrounds
* **retro:** awesome generated, 8-bit arcade-style pixelated faces
* **robohash:** a generated robot with different colors, faces, etc
* **blank:** a transparent PNG image (border added to HTML below for demonstration purposes)
You can [see here][Gravatar Default Image] how each type of default image looks like.
To show a particular default image out of the above, add the following setting to your `settings.py` file.
```python
GRAVATAR_DEFAULT_URL = 'identicon' # Choose any one of the above
```
## Contribute
Contributions are welcome. If you spot any bug(s), have a feature request, or anything else, don't hesitate to *do a [Pull Request][GitHub dj-gravatar pull request]*, or *opening an issue* from [here][GitHub dj-gravatar issues].
[Dj-Gravatar repo]: https://github.com/PhysicistSouravDas/dj-gravatar
[GitHub zip]: https://github.com/PhysicistSouravDas/dj-gravatar/archive/refs/heads/master.zip
[Gravatar Default Image]: https://en.gravatar.com/site/implement/images/#default-image
[GitHub dj-gravatar pull request]: https://github.com/PhysicistSouravDas/dj-gravatar/pulls
[GitHub dj-gravatar issues]: https://github.com/PhysicistSouravDas/dj-gravatar/issues