← Back to branch summary

~ubuntu-branches/ubuntu/karmic/pypy/karmic

« back to all changes in this revision

Viewing changes to py/doc/bin.txt

  • Committer: Bazaar Package Importer
  • Author(s): Alexandre Fayolle
  • Date: 2007-04-13 09:33:09 UTC
  • Revision ID: james.westby@ubuntu.com-20070413093309-yoojh4jcoocu2krz
Tags: upstream-1.0.0
Import upstream version 1.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
py/doc/bin.txt
 
1
======================
 
2
``py/bin/`` scripts 
 
3
======================
 
4
 
 
5
The py-lib contains some scripts, most of which are 
 
6
small ones (apart from ``py.test``) that help during
 
7
the python development process.  If working
 
8
from a svn-checkout of py lib you may add ``py/bin`` 
 
9
to your shell ``PATH`` which should make the scripts
 
10
available on your command prompt. 
 
11
 
 
12
``py.test``
 
13
===========
 
14
 
 
15
The ``py.test`` executable is the main entry point into the py-lib testing tool,
 
16
see the `py.test documentation`_.
 
17
 
 
18
.. _`py.test documentation`: test.html
 
19
 
 
20
``py.cleanup``
 
21
==============
 
22
 
 
23
Usage: ``py.cleanup [PATH]``
 
24
 
 
25
Delete pyc file recursively, starting from ``PATH`` (which defaults to the
 
26
current working directory). Don't follow links and don't recurse into
 
27
directories with a ".".
 
28
 
 
29
 
 
30
``py.countloc``
 
31
===============
 
32
 
 
33
Usage: ``py.countloc [PATHS]``
 
34
 
 
35
Count (non-empty) lines of python code and number of python files recursively
 
36
starting from a ``PATHS`` given on the command line (starting from the current
 
37
working directory). Distinguish between test files and normal ones and report
 
38
them separately.
 
39
 
 
40
``py.lookup``
 
41
=============
 
42
 
 
43
Usage: ``py.lookup SEARCH_STRING [options]``
 
44
 
 
45
Looks recursively at Python files for a ``SEARCH_STRING``, starting from the
 
46
present working directory. Prints the line, with the filename and line-number
 
47
prepended.
 
48
 
 
49
``py.rest``
 
50
===========
 
51
 
 
52
Usage: ``py.rest [PATHS] [options]``
 
53
 
 
54
Loot recursively for .txt files starting from ``PATHS`` and convert them to
 
55
html using docutils (or to pdf files, if the --pdf option is used).
 
56
 
 
57
``py.rest`` has some extra features over rst2html (which is shipped with
 
58
docutils). Most of these are still experimental, the one which is most likely
 
59
not going to change is the `graphviz`_ directive. With that you can embed .dot
 
60
files into your document and have them be converted to png (when outputting
 
61
html) and to eps (when outputting pdf). Otherwise the directive works mostly
 
62
like the image directive::
 
63
 
 
64
    .. graphviz:: example.dot
 
65
       :scale: 90
 
66
 
 
67
.. _`graphviz`: http://www.graphviz.org