product-release-notes
Add a changelog for your website that includes release notes for each of your clients.
- Support for multiple clients (iOS, Android, Web)
- RSS feed of changes
- Easily extend the style of the page
- Automatically pull release notes from iTunes
- Automatically pull release notes from Google Play
- Supports Markdown
You can either install it as a package into your existing project, or deploy directly to Heroku.
Edit releases using the Django Admin.
Examples
Installation
- Install the python package
pip install product_release_notes
-
Add
product_release_notestoINSTALLED_APPSin yoursettings.py. -
Add a url to your
urls.py.
# project.urls.py
from django.conf.urls import url, include
urlpatterns = [
url(r'^release-notes/', include('product_release_notes.urls')),
]- Run migrations to create the release notes tables.
./manage.py migrate
Settings
Optional settings to customize the release notes page.
RELEASE_NOTES_PAGE_DESCRIPTION = 'My product updates.'
RELEASE_NOTES_AUTO_PUBLISH = False- Optional - Create release note drafts when new versions are released to iTunes
Fill in the itunes_url field when creating a client.
Add a scheduled job to run at least daily to check for new versions in iTunes and Google Play
./manage.py check_app_stores
- Optional - Customize the release notes page
Create a template release_notes/base.html to override the packages base template.
<!DOCTYPE html>
<html>
<head>
<title>Release Notes</title>
{% block release_notes_extra_head %}{% endblock %}
</head>
<body>
{% block release_notes_body_header %}{% endblock %}
{% block release_notes_body %}{% endblock %}
</body>
</html>