Skip to main content

Django wrapper for pydoc

Project description

Djydoc

Read Python Documentation within a Django Project.

So you're happily going along in development and you want to quickly view documentation in a module. For python modules this is a piece of cake.

However, when you try to find out more information about a Django app, you may have come across an error like this...

error-1

Or like this...

error-2

And you may have done this...

scream

But after installing djydoc now you can do this:

relax

Djydoc aims to be a simple drop-in replacement as a manage.py command for pydoc so that you can view Python documentation without having to specify DJANGO_SETTINGS_MODULE or run django.setup(). Djydoc does that for you.

Summary

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • Django 2.2.4+
  • Poetry (optional, to help easily install)

Installing

Option 1 : PIP

$ pip install djydoc

Option 2: Development install via poetry

$ git clone <git_url>
$ cd djydoc
$ poetry install

Option 3: use as a Django app

Just follow option 2, but don't install with poetry

Options 1, 2, or 3: Setup

Add 'djydoc' to INSTALLED_APPS in settings:

INSTALLED_APPS += [
  'djydoc'
]

Usage

Once installed djydoc should be available via the ./manage.py command.

The intention is for this to be a drop-in replacement for pydoc, so all the commands should work the same (currently -w is not implemented):

$ ./manage.py djydoc django.contrib.auth.models.User

[ documentation shown ]

$ ./manage.py djydoc -p 8080
Server ready at http://0.0.0.0:8080/
Server commands: [b]rowser, [q]uit
server>

Running the tests

Testing TBD.

Deployment

Follow common sense django deployment practices.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Jordan H. - Code Author - SrcRr

License

This project is licensed under MIT.

Acknowledgments

TBD

Project details


Download files

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

Source Distribution

djydoc-0.1.3.dev0.tar.gz (4.2 kB view hashes)

Uploaded source

Built Distribution

djydoc-0.1.3.dev0-py2.py3-none-any.whl (4.1 kB view hashes)

Uploaded py2 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