A django-humans-txt documentation
django-humans-txt is a Django reusable application to handle humans.txt (http://humanstxt.org/)
Installation
- Obtain your copy of source code from the git repository:
$ git clone https://github.com/vint21h/django-humans-txt.git. Or download the latest release from https://github.com/vint21h/django-humans-txt/tags/. - Run
$ python ./setup.py installfrom the repository source tree or the unpacked archive. Or use pip:$ pip install django-humans-txt.
Configuration
- Add
"humans_txt"tosettings.INSTALLED_APPS:
# settings.py
INSTALLED_APPS += [
"humans_txt",
]- Add
"humans_txt"to your URLs definitions:
# urls.py
from django.urls import re_path
urlpatterns += [
re_path(r"^humans\.txt", include("humans_txt.urls")),
]- Run
$ python ./manage.py migratein your project folder to apply app migrations.
Settings
HUMANS_TXT_BANNER- Contains a banner that placed at the start of humans.txt response. Defaults to
"". HUMANS_TXT_LAST_UPDATE- Contains project last update date. Defaults to
None. HUMANS_TXT_LANGUAGES- Contains list of site supported languages. Defaults to
None.
Usage
- Include
"humans_txt/includes/humans_txt_meta.html"in your base template rel meta tag to<head>HTML tag:
{# base.html #}
<head>
{% include "humans_txt/includes/humans_txt_meta.html" %}
</head>- Just fill Django humans.txt models instances in your admin in your taste.
Contributing
- Fork it
- Install GNU Make
- Install and configure pyenv and pyenv-virtualenv plugin
- Install and configure direnv
- Create environment config from example
cp .env.example .env- Install development dependencies:
make install- Create your fix/feature branch:
git checkout -b my-new-fix-or-feature- Check code style and moreover:
make check- Run tests:
make test- Push to the branch:
git push origin my-new-fix-or-featureLicensing
django-humans-txt is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (a t your option) any later version. For complete license text see COPYING file.
Contacts
Project Website: https://github.com/vint21h/django-humans-txt/
Author: Alexei Andrushievich <vint21h@vint21h.pp.ua>
For other authors list see AUTHORS file.
