[Checkins] SVN: zope.configuration/trunk/ Add page on hacking the package.
Tres Seaver
cvs-admin at zope.org
Mon Jul 2 20:46:11 UTC 2012
Log message for revision 127236:
Add page on hacking the package.
Changed:
_U zope.configuration/trunk/
A zope.configuration/trunk/docs/hacking.rst
U zope.configuration/trunk/docs/index.rst
-=-
Added: zope.configuration/trunk/docs/hacking.rst
===================================================================
--- zope.configuration/trunk/docs/hacking.rst (rev 0)
+++ zope.configuration/trunk/docs/hacking.rst 2012-07-02 20:46:03 UTC (rev 127236)
@@ -0,0 +1,331 @@
+Hacking on :mod:`zope.configuration`
+============================
+
+
+Getting the Code
+-----------------
+
+The main repository for :mod:`zope.configuration` is in the Zope Subversion
+repository:
+
+http://svn.zope.org/zope.configuration
+
+You can get a read-only Subversion checkout from there:
+
+.. code-block:: sh
+
+ $ svn checkout svn://svn.zope.org/repos/main/zope.configuration/trunk zope.configuration
+
+The project also mirrors the trunk from the Subversion repository as a
+Bazaar branch on Launchpad:
+
+https://code.launchpad.net/zope.configuration
+
+You can branch the trunk from there using Bazaar:
+
+.. code-block:: sh
+
+ $ bzr branch lp:zope.configuration
+
+
+Running the tests in a ``virtualenv``
+-------------------------------------
+
+If you use the ``virtualenv`` package to create lightweight Python
+development environments, you can run the tests using nothing more
+than the ``python`` binary in a virtualenv. First, create a scratch
+environment:
+
+.. code-block:: sh
+
+ $ /path/to/virtualenv --no-site-packages /tmp/hack-zope.configuration
+
+Next, get this package registered as a "development egg" in the
+environment:
+
+.. code-block:: sh
+
+ $ /tmp/hack-zope.configuration/bin/python setup.py develop
+
+Finally, run the tests using the build-in ``setuptools`` testrunner:
+
+.. code-block:: sh
+
+ $ /tmp/hack-zope.configuration/bin/python setup.py test
+ running test
+ ........
+ ----------------------------------------------------------------------
+ Ran 249 tests in 0.366s
+
+ OK
+
+If you have the :mod:`nose` package installed in the virtualenv, you can
+use its testrunner too:
+
+.. code-block:: sh
+
+ $ /tmp/hack-zope.configuration/bin/easy_install nose
+ ...
+ $ /tmp/hack-zope.configuration/bin/python setup.py nosetests
+ running nosetests
+ .......
+ ----------------------------------------------------------------------
+ Ran 249 tests in 0.366s
+
+ OK
+
+or:
+
+.. code-block:: sh
+
+ $ /tmp/hack-zope.configuration/bin/nosetests
+ .......
+ ----------------------------------------------------------------------
+ Ran 249 tests in 0.366s
+
+ OK
+
+If you have the :mod:`coverage` pacakge installed in the virtualenv,
+you can see how well the tests cover the code:
+
+.. code-block:: sh
+
+ $ /tmp/hack-zope.configuration/bin/easy_install nose coverage
+ ...
+ $ /tmp/hack-zope.configuration/bin/python setup.py nosetests \
+ --with coverage --cover-package=zope.configuration
+ running nosetests
+ ...
+ Name Stmts Miss Cover Missing
+ ----------------------------------------------------------------
+ zope.configuration 3 0 100%
+ zope.configuration._compat 2 0 100%
+ zope.configuration.config 439 0 100%
+ zope.configuration.docutils 34 0 100%
+ zope.configuration.exceptions 2 0 100%
+ zope.configuration.fields 111 0 100%
+ zope.configuration.interfaces 18 0 100%
+ zope.configuration.name 54 0 100%
+ zope.configuration.stxdocs 6 0 100%
+ zope.configuration.xmlconfig 269 0 100%
+ zope.configuration.zopeconfigure 17 0 100%
+ ----------------------------------------------------------------
+ TOTAL 955 0 100%
+ ----------------------------------------------------------------------
+ Ran 256 tests in 1.063s
+
+ OK
+
+
+Building the documentation in a ``virtualenv``
+----------------------------------------------
+
+:mod:`zope.configuration` uses the nifty :mod:`Sphinx` documentation system
+for building its docs. Using the same virtualenv you set up to run the
+tests, you can build the docs:
+
+.. code-block:: sh
+
+ $ /tmp/hack-zope.configuration/bin/easy_install Sphinx
+ ...
+ $ cd docs
+ $ PATH=/tmp/hack-zope.configuration/bin:$PATH make html
+ sphinx-build -b html -d _build/doctrees . _build/html
+ ...
+ build succeeded.
+
+ Build finished. The HTML pages are in _build/html.
+
+You can also test the code snippets in the documentation:
+
+.. code-block:: sh
+
+ $ PATH=/tmp/hack-zope.configuration/bin:$PATH make doctest
+ sphinx-build -b doctest -d _build/doctrees . _build/doctest
+ ...
+
+ Doctest summary
+ ===============
+ 554 tests
+ 0 failures in tests
+ 0 failures in setup code
+ build succeeded.
+ Testing of doctests in the sources finished, look at the \
+ results in _build/doctest/output.txt.
+
+
+Running the tests using :mod:`zc.buildout`
+-------------------------------------------
+
+:mod:`zope.configuration` ships with its own :file:`buildout.cfg` file and
+:file:`bootstrap.py` for setting up a development buildout:
+
+.. code-block:: sh
+
+ $ /path/to/python2.6 bootstrap.py
+ ...
+ Generated script '.../bin/buildout'
+ $ bin/buildout
+ Develop: '/home/tseaver/projects/Zope/BTK/configuration/.'
+ ...
+ Generated script '.../bin/sphinx-quickstart'.
+ Generated script '.../bin/sphinx-build'.
+
+You can now run the tests:
+
+.. code-block:: sh
+
+ $ bin/test --all
+ Running zope.testing.testrunner.layer.UnitTests tests:
+ Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
+ Ran 249 tests with 0 failures and 0 errors in 0.366 seconds.
+ Tearing down left over layers:
+ Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
+
+
+Building the documentation using :mod:`zc.buildout`
+---------------------------------------------------
+
+The :mod:`zope.configuration` buildout installs the Sphinx scripts required to build
+the documentation, including testing its code snippets:
+
+.. code-block:: sh
+
+ $ cd docs
+ $ bin/sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
+ ...
+ Doctest summary
+ ===============
+ 554 tests
+ 0 failures in tests
+ 0 failures in setup code
+ build succeeded.
+ Testing of doctests in the sources finished, look at the results in .../docs/_build/doctest/output.txt.
+ .../bin/sphinx-build -b html -d .../docs/_build/doctrees .../docs .../docs/_build/html
+ ...
+ build succeeded.
+
+
+Running Tests on Multiple Python Versions via :mod:`tox`
+--------------------------------------------------------
+
+`tox <http://tox.testrun.org/latest/>`_ is a Python-based test automation
+tool designed to run tests against multiple Python versions. It creates
+a ``virtualenv`` for each configured version, installs the current package
+and configured dependencies into each ``virtualenv``, and then runs the
+configured commands.
+
+:mod:`zope.configuration` configures the following :mod:`tox` environments via
+its ``tox.ini`` file:
+
+- The ``py26`` environment builds a ``virtualenv`` with ``python2.6``,
+ installs :mod:`zope.configuration`, and runs the tests
+ via ``python setup.py test -q``.
+
+- The ``py27`` environment builds a ``virtualenv`` with ``python2.7``,
+ installs :mod:`zope.configuration`, and runs the tests
+ via ``python setup.py test -q``.
+
+- The ``py32`` environment builds a ``virtualenv`` with ``python3.2``,
+ installs :mod:`zope.configuration` and dependencies, and runs the tests
+ via ``python setup.py test -q``.
+
+- The ``pypy`` environment builds a ``virtualenv`` with ``pypy``,
+ installs :mod:`zope.configuration`, and runs the tests
+ via ``python setup.py test -q``.
+
+- The ``coverage`` environment builds a ``virtualenv`` with ``python2.6``,
+ installs :mod:`zope.configuration`, installs
+ :mod:`nose` and :mod:`coverage`, and runs ``nosetests`` with statement
+ coverage.
+
+- The ``docs`` environment builds a virtualenv with ``python2.6``, installs
+ :mod:`zope.configuration`, installs ``Sphinx`` and
+ dependencies, and then builds the docs and exercises the doctest snippets.
+
+This example requires that you have a working ``python2.6`` on your path,
+as well as installing ``tox``:
+
+.. code-block:: sh
+
+ $ tox -e py26
+ GLOB sdist-make: .../zope.interface/setup.py
+ py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip
+ py26 runtests: commands[0]
+ ..........
+ ----------------------------------------------------------------------
+ Ran 249 tests in 0.366s
+
+ OK
+ ___________________________________ summary ____________________________________
+ py26: commands succeeded
+ congratulations :)
+
+Running ``tox`` with no arguments runs all the configured environments,
+including building the docs and testing their snippets:
+
+.. code-block:: sh
+
+ $ tox
+ GLOB sdist-make: .../zope.interface/setup.py
+ py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip
+ py26 runtests: commands[0]
+ ...
+ Doctest summary
+ ===============
+ 544 tests
+ 0 failures in tests
+ 0 failures in setup code
+ 0 failures in cleanup code
+ build succeeded.
+ ___________________________________ summary ____________________________________
+ py26: commands succeeded
+ py27: commands succeeded
+ py32: commands succeeded
+ pypy: commands succeeded
+ coverage: commands succeeded
+ docs: commands succeeded
+ congratulations :)
+
+
+Submitting a Bug Report
+-----------------------
+
+:mod:`zope.configuration` tracks its bugs on Launchpad:
+
+https://bugs.launchpad.net/zope.configuration
+
+Please submit bug reports and feature requests there.
+
+
+Sharing Your Changes
+--------------------
+
+.. note::
+
+ Please ensure that all tests are passing before you submit your code.
+ If possible, your submission should include new tests for new features
+ or bug fixes, although it is possible that you may have tested your
+ new code by updating existing tests.
+
+If you got a read-only checkout from the Subversion repository, and you
+have made a change you would like to share, the best route is to let
+Subversion help you make a patch file:
+
+.. code-block:: sh
+
+ $ svn diff > zope.configuration-cool_feature.patch
+
+You can then upload that patch file as an attachment to a Launchpad bug
+report.
+
+If you branched the code from Launchpad using Bazaar, you have another
+option: you can "push" your branch to Launchpad:
+
+.. code-block:: sh
+
+ $ bzr push lp:~tseaver/zope.configuration/cool_feature
+
+After pushing your branch, you can link it to a bug report on Launchpad,
+or request that the maintainers merge your branch using the Launchpad
+"merge request" feature.
Modified: zope.configuration/trunk/docs/index.rst
===================================================================
--- zope.configuration/trunk/docs/index.rst 2012-07-02 20:27:37 UTC (rev 127235)
+++ zope.configuration/trunk/docs/index.rst 2012-07-02 20:46:03 UTC (rev 127236)
@@ -24,7 +24,11 @@
api/xmlconfig
api/zopeconfigure
+.. toctree::
+ :maxdepth: 2
+ hacking
+
Indices and tables
==================
More information about the checkins
mailing list