Metadata-Version: 2.1
Name: django-humans-txt
Version: 0.2.7
Summary: Handle humans.txt
Home-page: https://github.com/vint21h/django-humans-txt/
Author: Alexei Andrushievich
Author-email: vint21h@vint21h.pp.ua
License: GPLv3
Platform: UNKNOWN
Classifier: Environment :: Plugins
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: Unix
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Utilities
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Description-Content-Type: text/x-rst
Requires-Dist: django (>=2.0)
Requires-Dist: django-appconf (>=1.0.3)
Provides-Extra: dev
Requires-Dist: twine (==1.13.0) ; extra == 'dev'
Requires-Dist: readme-renderer (==24.0) ; extra == 'dev'
Requires-Dist: pygments (==2.4.2) ; extra == 'dev'
Provides-Extra: test
Requires-Dist: django-nose (==1.4.6) ; extra == 'test'
Requires-Dist: rednose (==1.3.0) ; extra == 'test'
Requires-Dist: nose-timer (==0.7.5) ; extra == 'test'
Requires-Dist: nose-exclude (==0.5.0) ; extra == 'test'
Requires-Dist: coverage (==4.5.4) ; extra == 'test'
Requires-Dist: mypy (==0.720) ; extra == 'test'
Requires-Dist: isort[pipfile] (==4.3.21) ; extra == 'test'
Requires-Dist: seed-isort-config (==1.9.2) ; extra == 'test'
Requires-Dist: pre-commit (==1.18.2) ; extra == 'test'
Requires-Dist: pre-commit-hooks (==2.3.0) ; extra == 'test'
Requires-Dist: flake8 (==3.7.8) ; extra == 'test'
Requires-Dist: flake8-docstrings (==1.4.0) ; extra == 'test'
Requires-Dist: black (==19.3b0) ; extra == 'test'
Requires-Dist: check-manifest (==0.39) ; extra == 'test'
Requires-Dist: tox (==3.13.2) ; extra == 'test'
Requires-Dist: tox-pyenv (==1.1.0) ; extra == 'test'
Requires-Dist: codacy-coverage (==1.3.11) ; extra == 'test'

.. django-humans-txt
.. README.rst

A django-humans-txt documentation
=================================

|Travis|_ |Coverage|_ |Codacy|_ |Requires|_ |pypi-license| |pypi-version| |pypi-python-version| |pypi-django-version| |pypi-format| |pypi-wheel| |pypi-status|

    *django-humans-txt is a django reusable application to handle humans.txt (http://humanstxt.org/)*

.. contents::

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``:

.. code-block:: python

    # settings.py

    INSTALLED_APPS += (
        "humans_txt",
    )

* Add ``"humans_txt"`` to your URLs definitions:

.. code-block:: python

    # urls.py

    urlpatterns += [
        url(r"^humans\.txt", include("humans_txt.urls")),
    ]

* Run ``python manage.py migrate`` in your project folder to apply app migrations.

django-humans-txt 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:

.. code-block:: django

    {# 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.

Licensing
---------
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.

.. |Travis| image:: https://travis-ci.org/vint21h/django-humans-txt.svg?branch=master
.. |Coverage| image:: https://api.codacy.com/project/badge/Coverage/6c967da4cf21436dacc49ca6961ea1b0
.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/6c967da4cf21436dacc49ca6961ea1b0
.. |Requires| image:: https://requires.io/github/vint21h/django-humans-txt/requirements.svg?branch=master
.. |pypi-license| image:: https://img.shields.io/pypi/l/django-humans-txt
.. |pypi-version| image:: https://img.shields.io/pypi/v/django-humans-txt
.. |pypi-django-version| image:: https://img.shields.io/pypi/djversions/django-humans-txt
.. |pypi-python-version| image:: https://img.shields.io/pypi/pyversions/django-humans-txt
.. |pypi-format| image:: https://img.shields.io/pypi/format/django-humans-txt
.. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/django-humans-txt
.. |pypi-status| image:: https://img.shields.io/pypi/status/django-humans-txt
.. _Travis: https://travis-ci.org/vint21h/django-humans-txt/
.. _Coverage: https://www.codacy.com/app/vint21h/django-humans-txt
.. _Codacy: https://www.codacy.com/app/vint21h/django-humans-txt
.. _Requires: https://requires.io/github/vint21h/django-humans-txt/requirements/?branch=master


