doccito 0.1.4

Send alerts, notifications, and messages based on events in your Django application

  Add it to your Download Basket!

 Add it to your Watch List!

0/5

Rate it!
send us
an update
LICENSE TYPE:
MIT/X Consortium License 
USER RATING:
UNRATED
  0.0/5
DEVELOPED BY:
Rootbuzz
HOMEPAGE:
doccito.com
CATEGORY:
ROOT \ Internet \ HTTP (WWW)
doccito sends alerts, notifications, and messages based on events in your Django apps.

Installation

Install lib with pip:

 pip install doccito

- OR -

Put the "doccito" directory somewhere in your python path

Usage

Doccito allows quick and easy documentation for your project by taking a readme.markdown file and constructing an html page with a table of contents corresponding to the document's tags.

More markdown syntax and examples can be found on the Markdown website, < a href = "http://daringfireball.net/projects/markdown/syntax" >here< /a >.

Command-Line Arguments

Running Doccito on the command-line allows use of either a provided base.html page for your document or a custom one with the [--template] command.

Running Doccito without any arguments will bring up it's help menu with optional arguments:

 -h, --help show help message and exit
 --stdio specifies stdio
 --template specifies custom html template
 --version

 show program's version number and exit

 cat README.markdown | python doccito.py --stdio > docs.html

- OR -

 python doccito.py README.markdown > docs.html

will take the README.markdown file and throw it into the default base.html template and create and send it to docs.html.

 cat README.markdown | python doccito.py --stdio --template layout.html > docs.html

will use layout.html as it's template.

API

Using Doccito as a library allows use of several functions:

doccito.create_docs

- input is a string containing the documentation in .markdown
- template is the .html template to be used (optional)

Example usage:

 import doccito

 doccito.create_docs(input, template="./base.html")

Last updated on September 13th, 2011

requirements

#events notifications #events messages #events alerts #Django #events #notifications #messages

Add your review!

SUBMIT