Welcome to Django ACME’s documentation!

Contents:

Django ACME

NOT MAINTAINED ANYMORE

This project isn’t maintained anymore, django-letsencrypt serves the same purpose but with a more features. Please use that instead.

A re-usable Django app to quickly deploy a page for the ACME challenge

Documentation

The full documentation is at https://django-acme.readthedocs.io.

Quickstart

Install Django ACME:

pip install django-acme

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'acme_challenge',
    ...
)

Add the Django ACME’s URL patterns:

from acme_challenge import urls as acme_challenge_urls


urlpatterns = [
    ...
    url(r'^', include(acme_challenge_urls)),
    ...
]

The URL of the ACME challenge to serve as well as the content are controlled via 2 settings which default to:

ACME_CHALLENGE_URL_SLUG = os.getenv('ACME_CHALLENGE_URL_SLUG')
ACME_CHALLENGE_TEMPLATE_CONTENT = os.getenv('ACME_CHALLENGE_TEMPLATE_CONTENT')

The slug being the suffix of the URL path: /.well-known/acme-challenge/[ACME_CHALLENGE_URL_SLUG]/

Features

• TODO

Running Tests

Does the code actually work? This projects uses tox:

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox [-e py27-django18]

Credits

Tools used in rendering this package:

• Cookiecutter
• cookiecutter-djangopackage

Installation

At the command line:

$ easy_install django-acme

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-acme
$ pip install django-acme

Usage

To use Django ACME in a project:

import acme_challenge

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/browniebroke/django-acme/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

Django ACME could always use more documentation, whether as part of the official Django ACME docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/browniebroke/django-acme/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up django-acme for local development.

1. Fork the django-acme repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/django-acme.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv django-acme
   $ cd django-acme/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 acme_challenge tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/browniebroke/django-acme/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_acme_challenge

Credits

Development Lead

• Bruno Alla <alla.brunoo@gmail.com>

Contributors

None yet. Why not be the first?

History

0.2.1 (2016-11-25)

• Settings are taken from the environment variables by default

0.2.0 (2016-11-17)

• The root URL includes the .well-known/acme-challenge/ prefix.
• Accept an optional / at the end of the URL
• Updated documentation

0.1.3 (2016-11-17)

• Bump version, various minor docs updates

0.1.0 (2016-11-16)

• First release on PyPI.