Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A pyramid plugin that describes a pyramid application URL hierarchy via inspection.

Project Description
===================================
Self-Documentation for Pyramid Apps
===================================

A Pyramid plugin that makes a Pyramid application self-documenting via
inspection/reflection to:

1. Describe the application URL structure,
2. Extract documentation from Python comments, and
3. Generate formal syntax using commenting conventions.

The resulting documentation can be served by the application to an
HTTP request or displayed on the command line. It has built-in support
for plain-text hierachies, reStructuredText, HTML, PDF, JSON, YAML,
WADL, and XML, however other custom formats can be added easily.

Exposing an application's structure via HTTP is useful to dynamically
generate an API description (via WADL, JSON, or YAML) or to create
documentation directly from source code.

On the command-line it is useful to get visibility into an
application's URL structure and hierarchy so that it can be understood
and maintained.

.. note::

Although pyramid-describe is intended to be able to describe any
kind of pyramid application, currently it only supports
pyramid-controllers_ based dispatch.

.. note::

Currently, pyramid-describe can only inspect the first Controller
it finds -- this will eventually be fixed to correctly implement
the `inspect` option.
Release History

Release History

This version
History Node

0.5.3

History Node

0.5.2

History Node

0.5.1

History Node

0.4.7

History Node

0.4.6

History Node

0.4.5

History Node

0.4.4

History Node

0.4.3

History Node

0.4.2

History Node

0.4.1

History Node

0.4.1b

History Node

0.4.0

History Node

0.4.0c

History Node

0.4.0b

History Node

0.3.3

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.2.0

History Node

0.1.35

History Node

0.1.34

History Node

0.1.33

History Node

0.1.32

History Node

0.1.31

History Node

0.1.30

History Node

0.1.30b

History Node

0.1.29

History Node

0.1.28

History Node

0.1.27

History Node

0.1.26

History Node

0.1.25

History Node

0.1.23

History Node

0.1.22

History Node

0.1.21

History Node

0.1.20

History Node

0.1.19.36

History Node

0.1.19.34

History Node

0.1.19.33

History Node

0.1.19.32

History Node

0.1.19.30

History Node

0.1.19.28

History Node

0.1.19.27

History Node

0.1.19.26

History Node

0.1.19.25

History Node

0.1.19.24

History Node

0.1.19.23

History Node

0.1.19.22

History Node

0.1.19.21

History Node

0.1.19.20

History Node

0.1.19.19

History Node

0.1.19.18

History Node

0.1.19.17

History Node

0.1.19.16

History Node

0.1.19.15

History Node

0.1.19.14

History Node

0.1.19.13

History Node

0.1.19.12

History Node

0.1.19.11

History Node

0.1.19.10

History Node

0.1.19.9

History Node

0.1.19.8

History Node

0.1.19.7

History Node

0.1.19.6

History Node

0.1.19.5

History Node

0.1.19.4

History Node

0.1.19.3

History Node

0.1.19.1

History Node

0.1.19

History Node

0.1.18

History Node

0.1.16

History Node

0.1.15

History Node

0.1.14

History Node

0.1.13

History Node

0.1.11

History Node

0.1.10

History Node

0.1.9

History Node

0.1.8

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.3.3

History Node

0.1.3.2

History Node

0.1.3.1

History Node

0.1.3

History Node

0.0.2

History Node

0.0.1

History Node

0.4.0i

History Node

0.4.0h

History Node

0.4.0g

History Node

0.4.0f

History Node

0.4.0e

History Node

0.4.0d

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pyramid_describe-0.5.3.tar.gz (167.6 kB) Copy SHA256 Checksum SHA256 Source Apr 21, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting