/django-topography

EXPERIMENTAL: Map the URL structure of a Django application

Primary LanguagePythonBSD 2-Clause "Simplified" LicenseBSD-2-Clause

topography

Introspects the URL structure of a Django application and produces a JSON-encoded description.

Installation: pip install django-topography then add topography to INSTALLED_APPS.

Usage: manage.py topography

Example output:

{
  "timestamp": "2016-07-22T09:07:58.940316",
  "version": 0,
  "urls": [
    {
      "url": "/",
      "view": {
        "docs": "This view is responsible for the homepage of the website",
        "name": "index",
        "methods": [
          {
            "docs": "Render the homepage",
            "lines": 2,
            "name": "GET"
          }
        ]
      }
    },
    ...

Code of conduct

For guidelines regarding the code of conduct when contributing to this repository please review https://www.dabapps.com/open-source/code-of-conduct/