django-letsencrypt 6.0.1

A simple Django app to handle Let's Encrypt ACME challenges.

Let's Encrypt App for Django

django-letsencrypt will allow you to add, remove, and update any ACME challenge objects you may need through your Django admin interface. Simply add the ACME challenge and response for your app to serve up the necessary information for Let's Encrypt validation.

This project strives to make installation, configuration, and usage a snap! From high levels of code coverage, multiple compatible python versions, multiple versions of Django supported, even multiple databases too!

And of course all wrapped up and published to PyPI for standard installation!

Supported Configurations

django-letsencrypt is tested across a number of configurations, here's what's supported so far:

• Python Versions Supported:
  • 3.14 (with Django 6.0, 5.2)
  • 3.13 (with Django 6.0, 5.2)
  • 3.12 (with Django 6.0, 5.2, 4.2)
  • 3.11 (with Django 5.2, 4.2)
  • 3.10 (with Django 5.2, 4.2)
• Django Versions Supported:
  • 6.0 minimum version 6.0.2
  • 5.2 LTS minimum version 5.2.11
  • 4.2 LTS minimum version 4.2.28
• Databases Supported:
  • mysql
  • postgres
  • sqlite

Recent Build Status Badges

• 
• 
• 
• 
• 

Installation & Configuration

1. pip install django-letsencrypt

2. Add letsencrypt to your INSTALLED_APPS

INSTALLED_APPS = [
   ... ,
   'letsencrypt',
   ... ,
]

3. Include the letsencrypt in your project's urls.py, or where applicable (usually your root urls.py).

re_path(r'^\.well-known/', include('letsencrypt.urls'))

4. Run manage.py migrate to create the required table for the letsencrypt model

5. Create your ACME Challenge objects in your Django admin interface

6. Test your ACME Challenge objects and their responses by visiting them:

{Django Site}/.well-known/acme-challenge/challenge_text

7. Enjoy your easy to manage ACME Challenges inside your Django project!

Example Project

If you would like a demo of how to use this application simply clone this project's git repository from GitHub, take a moment to read the README.md file within the example_project directory, and follow the directions. That will spin up a small sample django application already configured for you to try out.

Development

1. Make sure you have installed uv in your environment.
2. Clone the repo to your development machine.
3. Configure your git hooks with git config core.hooksPath .githooks for the project.
4. Run uv sync to create the virtual environment and install required dependencies.
5. Run make test for the full test suite.
6. Run make test-tox to run the entire tox suite.