Handle humans.txt
Project description
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 install from the repository source tree or the unpacked archive. Or use pip: $ pip install django-humans-txt.
Configuration
Add "humans_txt" to settings.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 migrate in 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
Install GNU Make
Install and configure pyenv and pyenv-virtualenv plugin
Install and configure direnv
Create environment config from example
cp .env.example .envInstall development dependencies:
make installCreate your fix/feature branch:
git checkout -b my-new-fix-or-featureCheck code style and moreover:
make checkRun tests:
make testPush 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-humans-txt-0.16.2.zip.
File metadata
- Download URL: django-humans-txt-0.16.2.zip
- Upload date:
- Size: 45.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 51dbc5bc0d02c9583f133e2bb3d4a145a7e64827021e1932fcaf4275b3da3c42 |
|
| MD5 | b4f0796246da2a7ec1b20171e6696a0e |
|
| BLAKE2b-256 | 5b40ca9c0cca1736bb7239d3259a9a35a9e30a2ce19d75d2b3140195923154e8 |
File details
Details for the file django_humans_txt-0.16.2-py3-none-any.whl.
File metadata
- Download URL: django_humans_txt-0.16.2-py3-none-any.whl
- Upload date:
- Size: 33.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7a402c155e642e85a2370abbbab31e0af8dfa556f07287dff7bb236a3b8a5c6f |
|
| MD5 | 2fd1e9c1182368bfc68b89e272415ff3 |
|
| BLAKE2b-256 | f364a8d6e17aa258f29c73650214ff3a58c2925957a228bb814c05c9eac9dcc3 |
