Paver is a Python build tool that provides tasks for common build operations like installing dependencies, running tests, building documentation, and more. It aims to be simple for basic tasks but support more complex workflows. Paver embraces existing Python tools like distutils, setuptools, and virtualenv. It allows defining tasks and options in a pavement.py file and running tasks with a single command line. Paver also supports features like auto-discovery of Django apps and integration with tools like Fabric.

1. Paver: the build tool you missed
Lukas Linhart
Centrum Holdings

2. About Me
• Regular pythonista since '05
• Testing and automation obsession
• Centrum Holdings, mostly Django-related work
• Lots of smallish projects

3. Stumbling upon Paver
• "Setuptools no more"
• Kevin Dangoor To The Rescue

4. Survey
Who would use a build tool...

5. Build tool in an interpreted world
• Generated Content In Repository (TM)
• Moving (files) around

6. ...and why in Python?
• Batteries included (tm)
• Integration with pythonic tools

7. ...and why Paver?
• Simple things stay simple
• Complex is possible (or integrated)

8. Single Point of Entry
As in "Console API"
1 paver bootstrap
2 paver prepare
3 paver run

9. Getting started (First Task!)
pavement.py :
1 from paver.easy import *
2
3 @task
4 def install_dependencies():
5 sh('pip install --upgrade -r requirements.txt')

10. Embrace distutils/setuptools
1 from paver.easy import *
2 from paver.setuputils import setup
3
4 setup(**same_args_as_in_setup)

11. setup.py compatibility
paver minilib
paver generate_setup
(pip install -e worky)

12. Dependencies
1 @task
2 @needs('install_dependencies')
3 def prepare():
4 """ Prepare complete environment """
5 sh("python setup.py develop")

13. Overwriting distutils commands
1 @task
2 @needs('html', "minilib", "generate_setup", "distutils.command.sdist")
3 def sdist():
4 pass

14. Positional arguments
1 @task
2 @consume_args
3 def unit(args):
4 import nose
5 nose.run_exit(
6 argv = ["nosetests"] + args
7 )

15. CMD options, GNU style
1 @task
2 @cmdopts([
3 ('domain-username=', 'd', 'Domain username'),
4 ('upload-url=', 'u', 'URL to upload to')
5 ])
6 @needs('download_diff_packages')
7 def upload_packages(options):
8 # censored

16. Oh, options
1 options(
2 minilib=Bunch(
3 extra_files=['doctools', 'virtual']
4 )
5 )

17. Options (cont.)
1 # inside minilib task
2 options.get('extra_files', [])

18. Namespace search
1 options(setup=Bunch(version="1.1"))
2 options.version
3 '1.1'
4 options.order('minilib')
5 options.version
6 AttributeError: version

19. sh
1 myval = sh("cat /etc/fstab", capture=True)

20. dry
1 # prepare
2 dry("Modify", do_fs_mumbo_jumbo)

21. path.py
1 @task
2 def publish_docs():
3 builtdocs = path("docs") / options.sphinx.builddir / "html"
4 destdir = options.docroot
5 destdir.rmtree()
6 builtdocs.move(destdir)

22. Documentation (sphinx)
1 options(
2 sphinx=Bunch(
3 builddir="build",
4 sourcedir="source"
5 )
6 )
And run
1 paver html

23. Documentation (cog)
1 #<== include('started/oldway/setup.py')==>
2 #<==end==>
configured with
1 options(
2 cog=Bunch(
3 includedir="docs/samples",
4 beginspec="<==",
5 endspec="==>",
6 endoutput="<==end==>"
7 )
8 )

24. Virtualenv
1 options(
2 virtualenv=Bunch(
3 packages_to_install=["nose", "virtualenv"],
4 install_paver=True,
5 script_name='bootstrap.py',
6 paver_command_line=None,
7 dest_dir="virtualenv"
8 )
9 )

25. Discovery

26. Setting up django discovery
1 from paver.discovery import discover_django
2
3 options(
4 discovery = Bunch(
5 django = Bunch(
6 settings_path = "subdir"
7 )
8 )
9 )
10
11 discover_django(options)

27. Happy Django command panda
paver django.validate

28. Future
• virtualenv improvements
• VIRTUAL_ENV context autodetection
• more integration (first-class fabric, ...)
• what would you like?

29. Q & (some) A
Fork us on github
http://github.com/paver/paver/
paver@googlegroups.com