Font Awesome Free

6.6.0 · maintenance · verified Thu Apr 16

This Python package provides the static assets for Font Awesome Free icons, currently mirroring Font Awesome version 6.6.0. It's primarily designed for integration into Python web frameworks like Django, allowing developers to easily serve Font Awesome's CSS and JavaScript files for their web applications. While the upstream Font Awesome library has released version 7, the `fontawesomefree` PyPI package is not actively updated for Font Awesome 7 and is officially deprecated for new projects aiming for Font Awesome 7 integration.

Common errors

```
ModuleNotFoundError: No module named 'fontawesomefree'
```
cause The `fontawesomefree` package has not been installed in the active Python environment, or the environment is not correctly activated.

fix Run `pip install fontawesomefree` in your terminal to install the package.
```
ImproperlyConfigured: The app label 'fontawesome-free' is not a valid Python identifier.
```
cause Django versions 3.2 and later do not allow hyphens in app labels within `INSTALLED_APPS`. The `fontawesome-free` package internally uses a hyphenated label.

fix In your `settings.py` file, add `import sys; sys.modules['fontawesome_free'] = __import__('fontawesome-free')` before `INSTALLED_APPS`, and then list `'fontawesome_free'` (with an underscore) in your `INSTALLED_APPS`.
```
Font Awesome icons are not displaying on the webpage, or appear as squares/missing glyphs.
```
cause This is a common issue with several potential causes: 1) Incorrect or missing `<link>` tags for Font Awesome CSS/JS in your HTML template. 2) Incorrect paths for static files if self-hosting. 3) Multiple, conflicting versions of Font Awesome loaded on the same page. 4) Ad blockers or network issues preventing loading. 5) Incorrect icon class names (e.g., `fa-solid` instead of `fas`).

fix 1. Ensure `{% static 'fontawesomefree/css/all.min.css' %}` and `{% static 'fontawesomefree/js/all.min.js' %}` (or specific style files) are correctly linked in your HTML `<head>` after loading Django's static files. 2. Verify Django's `STATIC_URL` and `STATICFILES_DIRS` are correctly configured. 3. Check your browser's developer console for 404 errors related to Font Awesome files. 4. Ensure only one version of Font Awesome is loaded and that you are using the correct icon prefixes (e.g., `fas`, `fab`).

Warnings

breaking The `fontawesomefree` PyPI package is effectively deprecated for Font Awesome v7. It is not updated beyond v6.6.0, and official Font Awesome v7 documentation advises using 'Kits' (CDN or self-hosted) instead of the Python package for v7 integration.
Fix: For Font Awesome v7, consider using Font Awesome Kits (CDN-based or self-hosted) as recommended by the official documentation, rather than relying on the `fontawesomefree` PyPI package. This means manual integration of assets into your web project.
gotcha When using `fontawesomefree` with Django versions 3.2 or newer, you might encounter an `ImproperlyConfigured: The app label 'fontawesome-free' is not a valid Python identifier.` error because Django does not permit hyphens in `INSTALLED_APPS` labels.
Fix: To resolve this, add `import sys; sys.modules['fontawesome_free'] = __import__('fontawesome-free')` at the top of your `settings.py` file, before `INSTALLED_APPS`. Then, list `'fontawesome_free'` (with an underscore) in your `INSTALLED_APPS` list.
breaking Upgrading Font Awesome from versions like v5 or v6 (which this package provides) to v7 involves significant breaking changes. These include changes to icon syntax, icon naming conventions, default fixed-width icons, and updates to CSS/SCSS structure, requiring manual updates to HTML templates and custom stylesheets.
Fix: Refer to the official Font Awesome v7 upgrade guide. If self-hosting, you will need to replace old v6 files with v7 assets and update all references in your HTML/CSS to match the new syntax and file paths.

Install

pip install fontawesomefree Install latest version

Quickstart

The `fontawesomefree` package provides static files, not Python-callable functions. Its primary use in Python projects, especially Django, involves installing the package and then referencing its static CSS and JavaScript files in HTML templates. This example demonstrates how to set it up in a Django project's `settings.py` and `base.html` to enable Font Awesome icons. You would typically use `os.environ.get` for sensitive data, but for static asset paths, it's not applicable here.

import os

# For Django projects, add 'fontawesomefree' to INSTALLED_APPS in settings.py
# Then, include the static files in your base HTML template.

# settings.py example:
# INSTALLED_APPS = [
#     # ... other apps
#     'fontawesomefree',
#     # ...
# ]

# base.html (Django template) example:
# {% load static %}
# <head>
#     <!-- ... other head content ... -->
#     <link href="{% static 'fontawesomefree/css/all.min.css' %}" rel="stylesheet" type="text/css">
#     <script src="{% static 'fontawesomefree/js/all.min.js' %}"></script>
# </head>
# <body>
#     <i class="fas fa-home"></i> Home
#     <i class="fab fa-python"></i> Python
# </body>

view raw JSON →