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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
===========================================
Paver: Easy Scripting for Software Projects
===========================================
.. image:: _static/paver_banner.jpg
:height: 126
:width: 240
`Japanese translation available <http://paver.github.com/paver-docs-jp/>`_
thanks to Tetsuya Morimoto. Latest stable documentation is
`on PyPI <http://packages.python.org/Paver/>`_, latest development docs are
`on github pages <http://paver.github.com/>`_
Paver is a Python-based software project scripting tool along the
lines of Make or Rake. It is not designed to handle the dependency
tracking requirements of, for example, a C program. It *is* designed
to help out with all of your other repetitive tasks (run documentation
generators, moving files around, downloading things), all with the
convenience of Python's syntax and massive library of code.
If you're developing applications in Python, you get even more...
Most public Python projects use distutils or setuptools to create source
tarballs for distribution. (Private projects can take advantage of
this, too!) Have you ever wanted to generate the docs before building the
source distribution? With Paver, you can, trivially. Here's a complete
pavement.py::
from paver.easy import *
from paver.setuputils import setup
setup(
name="MyCoolProject",
packages=['mycool'],
version="1.0",
url="http://www.blueskyonmars.com/",
author="Kevin Dangoor",
author_email="dangoor@gmail.com"
)
@task
@needs(['html', "distutils.command.sdist"])
def sdist():
"""Generate docs and source distribution."""
pass
With that pavement file, you can just run ``paver sdist``, and your docs
will be rebuilt automatically before creating the source distribution.
It's also easy to move the generated docs into some other directory
(and, of course, you can tell Paver where your docs are stored,
if they're not in the default location.)
Features
--------
* Build files are :ref:`just Python <justpython>`
* :ref:`One file with one syntax <onefile>`, pavement.py, knows how to manage
your project
* :ref:`File operations <pathmodule>` are unbelievably easy, thanks to the
built-in version of Jason Orendorff's path.py.
* Need to do something that takes 5 lines of code?
:ref:`It'll only take 5 lines of code. <fivelines>`.
* Completely encompasses :ref:`distutils and setuptools <setuptools>` so
that you can customize behavior as you need to.
* Wraps :ref:`Sphinx <doctools>` for generating documentation, and adds utilities
that make it easier to incorporate fully tested sample code.
* Wraps :ref:`Subversion <svn>` for working with code that is checked out.
* Wraps :ref:`virtualenv <virtualenv>` to allow you to trivially create a
bootstrap script that gets a virtual environment up and running. This is
a great way to install packages into a contained environment.
* Can use all of these other libraries, but :ref:`requires none of them <nodeps>`
* Easily transition from setup.py without making your users learn about or
even install Paver! (See the :ref:`Getting Started Guide <gettingstarted>`
for an example).
See how it works! Check out the :ref:`Getting Started Guide <gettingstarted>`.
Paver was created by `Kevin Dangoor <http://blueskyonmars.com>`_ of `SitePen <http://sitepen.com>`_.
Status
------
Paver has been in use in production settings since mid-2008, and significant
attention is paid to backwards compatibility since the release of 1.0.
See the :ref:`changelog <changelog>` for more information about recent improvements.
Installation
------------
The easiest way to get Paver is if you have pip_ or distutils_ installed.
``pip install Paver``
or
``easy_install Paver``
Without setuptools, it's still pretty easy. Download the Paver .tgz file from
`Paver's Cheeseshop page`_, untar it and run:
``python setup.py install``
.. _Paver's Cheeseshop page: http://pypi.python.org/pypi/Paver/
.. _pip: http://www.pip-installer.org
.. _distribute: https://pypi.python.org/pypi/distribute
Help and Development
--------------------
You can get help from the `mailing list`_.
If you'd like to help out with Paver, you can check the code out from github:
``git clone https://github.com/paver/paver.git``
Ideally, create a fork, fix an issue from `Paver's list of issues`_ (or create an issue
Yourself) and send a pull request.
Your help is appreciated!
Running test suite
===================
Paver contains both unit and integration test suite. Unittests are run by either
``paver test`` or ``paver unit``. Integration tests can be run by ``paver integrate``.
Using older, system-wide installed paver to run tests on development version can lead
to bad interactions (see `issue 33`_). Please, run paver test suite using development
version itself, by:
* Creating virtual environment with --no-site-packages
and
* Installing development version with python setup.py develop
or
* Using embedded minilib, thus invoking commands with setup.py instead of paver
.. _mailing list: http://groups.google.com/group/paver
.. _Paver's list of issues: https://github.com/paver/paver/issues
.. _issue 33: https://github.com/paver/paver/issues/33
License
-------
Paver is licensed under a BSD license. See the LICENSE.txt file in the
distribution.
Contents
--------
.. toctree::
:maxdepth: 2
foreword
features
getting_started
pavement
paverstdlib
cmdline
tips
articles
changelog
credits
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
