summaryrefslogtreecommitdiff
path: root/README.rst
blob: 2aab0e1dbfb3c9e4c40b5d9f4e04ea7ee44c5f38 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Pecan
=====

A WSGI object-dispatching web framework, designed to be lean and fast with few
dependencies.

.. _travis: http://travis-ci.org/dreamhost/pecan
.. |travis| image:: https://secure.travis-ci.org/dreamhost/pecan.png

|travis|_

Installing
----------

::

    $ pip install pecan

...or, for the latest (unstable) tip::

    $ git clone https://github.com/dreamhost/pecan.git -b next
    $ cd pecan && python setup.py install

Running Tests
-------------

::

    $ python setup.py test

...or, to run all tests across all supported environments::

    $ pip install tox && tox

Viewing Documentation
---------------------
`Available online <http://pecan.readthedocs.org>`_, or to build manually::

    $ cd docs && make html
    $ open docs/build/html/index.html

...or::

    $ cd docs && make man
    $ man docs/build/man/pecan.1

Additional Help/Support
-----------------------
Most Pecan interaction is done via the #pecanpy channel on `FreeNode
<http://freenode.net/>`_ IRC.