Skip to main content

Handle humans.txt

Project description

GitHub Coveralls License Version Supported Python version Supported Django version Package format Python wheel support Package status

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

  1. Fork it
  2. Install GNU Make
  3. Install and configure pyenv and pyenv-virtualenv plugin
  4. Install and configure direnv
  5. Create environment config from example
cp .env.example .env
  1. Install development dependencies:
make install
  1. Create your fix/feature branch:
git checkout -b my-new-fix-or-feature
  1. Check code style and moreover:
make check
  1. Run tests:
make test
  1. Push to the branch:
git push origin my-new-fix-or-feature
  1. Create a new Pull Request

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.

Project details


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

django-humans-txt-0.16.2.zip (45.2 kB view hashes)

Uploaded source

Built Distribution

django_humans_txt-0.16.2-py3-none-any.whl (33.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page