Skip to main content

README.md generator for django projects

Project description

Installation

$ [sudo] pip install django-readme-generator

Features

  • based on readme-generator
    • <section-name>.md, attrs/methods/props as sections
    • auto headers
  • and python-readme-generator:
    • install, classes, functions, executable_modules, scripts_usage sections
  • django sections:
    • settings, models, commands

Config

$ export DJANGO_SETTINGS_MODULE="<django_settings_module>"

Classes

class __doc__
django_readme_generator.Readme methods: getmodules(), getapps(), getmodels(), getcommands(). sections as methods: settings(), models(), commands()

Executable modules

usage __doc__
python -m django_readme_generator [location ...] generate README.md

What's Next?

create custom README class

import django_readme_generator

class Readme(django_readme_generator.Readme):
    headers = {"badges":""}
    locations = django_readme_generator.Readme.locations + [".config/README"]
    order = ['badges',...]

    def badges(self):
        ...

Readme().save("README.md")

Related projects

django-readme-generator

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-readme-generator, version 2019.9.7
Filename, size File type Python version Upload date Hashes
Filename, size django-readme-generator-2019.9.7.tar.gz (3.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page