Skip to content

Commit

Permalink
Fix documentation about working on the package.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Howitz committed Sep 26, 2023
1 parent dd945e9 commit e16cd48
Showing 1 changed file with 35 additions and 226 deletions.
261 changes: 35 additions & 226 deletions docs/hacking.rst
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Hacking on :mod:`zope.hookable`
================================


Getting the Code
################

Expand All @@ -22,244 +21,72 @@ or fork it and get a writeable checkout of your fork:
$ git clone git@github.com/jrandom/zope.hookable.git
The project also mirrors the trunk from the Github repository as a
Bazaar branch on Launchpad:

https://code.launchpad.net/zope.hookable

You can branch the trunk from there using Bazaar:
.. code-block:: sh
$ bzr branch lp:zope.hookable
Using :mod:`tox`
################

Running Tests on Multiple Python Versions
-----------------------------------------

Working in a ``virtualenv``
###########################
`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.

Installing
----------
:mod:`zope.hookable` configures the following :mod:`tox` environments via
its ``tox.ini`` file:

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:
- The defined Python environments build a ``virtualenv/venv``, install
:mod:`zope.hookable` and dependencies, and run the tests via
``zope.testrunner`` There are environments both for with and without using
the C code extension.

.. code-block:: sh
- The ``coverage`` environment builds a ``virtualenv``,
installs :mod:`zope.hookable` and dependencies, installs
:mod:`coverage`, and runs the tests with coverage.

$ /path/to/virtualenv --no-site-packages /tmp/hack-zope.hookable
- The ``docs`` environment builds a virtualenv installs :mod:`zope.hookable`
and dependencies, installs ``Sphinx`` and dependencies, and then builds the
docs and exercises the doctest snippets.

Next, get this package registered as a "development egg" in the
environment:
This example requires that you have a working ``python3.11`` on your path,
as well as an installed ``tox``:

.. code-block:: sh
$ /tmp/hack-zope.hookable/bin/python setup.py develop
Running the tests
-----------------
$ tox -e py311
Run the tests using the build-in ``setuptools`` testrunner:
Running ``tox`` with no arguments runs all the configured environments,
including building the docs and testing their snippets:

.. code-block:: sh
$ /tmp/hack-zope.hookable/bin/python setup.py test -q
running test
...
----------------------------------------------------------------------
Ran 18 tests in 0.000s
OK
$ tox
The ``dev`` command alias downloads and installs extra tools, like the
:mod:`nose` testrunner and the :mod:`coverage` coverage analyzer:
To run the tests in parallel use:

.. code-block:: sh
$ /tmp/hack-zope.hookable/bin/python setup.py dev
$ /tmp/hack-zope.hookable/bin/nosetests
running nosetests
.................................... (lots more dots)
----------------------------------------------------------------------
Ran 18 tests in 0.001s
OK
$ tox -p auto
If you have the :mod:`coverage` pacakge installed in the virtualenv,
you can see how well the tests cover the code:
To see the coverage output:

.. code-block:: sh
$ /tmp/hack-zope.hookable/bin/nosetests --with coverage
running nosetests
.................................... (lots more dots)
Name Stmts Miss Cover Missing
----------------------------------------------------------------
zope.hookable 23 0 100%
----------------------------------------------------------------
TOTAL 23 0 100%
----------------------------------------------------------------------
Ran 18 tests in 0.001s
OK
$ tox -e coverage
Building the documentation
--------------------------

:mod:`zope.hookable` 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:

The ``docs`` command alias downloads and installs Sphinx and its dependencies:

.. code-block:: sh
$ /tmp/hack-zope.hookable/bin/python setup.py docs
...
$ bin/sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
...
build succeeded.
Build finished. The HTML pages are in docs/_build/html.
You can also test the code snippets in the documentation:

.. code-block:: sh
$ bin/sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest
...
running tests...
Document: index
---------------
1 items passed all tests:
13 tests in default
13 tests in 1 items.
13 passed and 0 failed.
Test passed.
Doctest summary
===============
13 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.
Using :mod:`zc.buildout`
########################

Setting up the buildout
-----------------------

:mod:`zope.hookable` ships with its own :file:`buildout.cfg` file and
:file:`bootstrap.py` for setting up a development buildout:
for building its docs.

.. code-block:: sh
$ /path/to/python2.6 bootstrap.py
...
Generated script '.../bin/buildout'
$ bin/buildout
Develop: '/home/jrandom/projects/Zope/BTK/hookable/.'
...
Generated script '.../bin/sphinx-quickstart'.
Generated script '.../bin/sphinx-build'.
Running the tests
-----------------

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 702 tests with 0 failures and 0 errors in 0.000 seconds.
Tearing down left over layers:
Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
Using :mod:`tox`
################

Running Tests on Multiple Python Versions
-----------------------------------------

`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.hookable` configures the following :mod:`tox` environments via
its ``tox.ini`` file:

- The ``py26``, ``py27``, ``py33``, ``py34``, and ``pypy`` environments
builds a ``virtualenv`` with ``pypy``,
installs :mod:`zope.hookable` and dependencies, and runs the tests
via ``python setup.py test -q``.

- The ``coverage`` environment builds a ``virtualenv`` with ``python2.6``,
installs :mod:`zope.hookable` and dependencies, installs
:mod:`nose` and :mod:`coverage`, and runs ``nosetests`` with statement
coverage.

- The ``docs`` environment builds a virtualenv with ``python2.6``, installs
:mod:`zope.hookable` and dependencies, 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.hookable/setup.py
py26 sdist-reinst: .../zope.hookable/.tox/dist/zope.hookable-4.0.2dev.zip
py26 runtests: commands[0]
...
----------------------------------------------------------------------
Ran 18 tests in 0.001s
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.hookable/setup.py
py26 sdist-reinst: .../zope.hookable/.tox/dist/zope.hookable-4.0.2dev.zip
py26 runtests: commands[0]
...
Doctest summary
===============
13 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 :)
$ tox -e docs
It also tests the code snippets in the documentation.

Contributing to :mod:`zope.hookable`
####################################
Expand All @@ -278,27 +105,9 @@ 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 have made a change you would like to share, the best route is to fork
the Githb repository, check out your fork, make your changes on a branch
the GitHub repository, check out your fork, make your changes on a branch
in your fork, and push it. You can then submit a pull request from your
branch:

https://github.com/zopefoundation/zope.hookable/pulls

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:~jrandom/zope.hookable/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.

0 comments on commit e16cd48

Please sign in to comment.