PyPI version License Python versions supported Format

Continuous integration test status Continuous integration test coverage Documentation status

Description

This package provides a light framework that can be used to automatically generate exceptions documentation marked up in reStructuredText.

The exdoc module details how to register exceptions, how to traced them and how to generate their documentation

Interpreter

The package has been developed and tested with Python 2.7, 3.5, 3.6 and 3.7 under Linux (Debian, Ubuntu), Apple macOS and Microsoft Windows

Installing

$ pip install pexdoc

Documentation

Available at Read the Docs

Contributing

  1. Abide by the adopted code of conduct

  2. Fork the repository from GitHub and then clone personal copy [1]:

    $ github_user=myname
$ git clone --recurse-submodules \
      https://github.com/"${github_user}"/pexdoc.git
Cloning into 'pexdoc'...
...
$ cd pexdoc || exit 1
$ export PEXDOC_DIR=${PWD}
$

  3. The package uses two sub-modules: a set of custom Pylint plugins to help with some areas of code quality and consistency (under the pylint_plugins directory), and a lightweight package management framework (under the pypkg directory). Additionally, the pre-commit framework is used to perform various pre-commit code quality and consistency checks. To enable the pre-commit hooks:

    $ cd "${PEXDOC_DIR}" || exit 1
$ pre-commit install
pre-commit installed at .../pexdoc/.git/hooks/pre-commit
$

  4. Ensure that the Python interpreter can find the package modules (update the $PYTHONPATH environment variable, or use sys.paths(), etc.)

    $ export PYTHONPATH=${PYTHONPATH}:${PEXDOC_DIR}
$

  5. Install the dependencies (if needed, done automatically by pip):

  6. Implement a new feature or fix a bug

  7. Write a unit test which shows that the contributed code works as expected. Run the package tests to ensure that the bug fix or new feature does not have adverse side effects. If possible achieve 100% code and branch coverage of the contribution. Thorough package validation can be done via Tox and Pytest:

    $ PKG_NAME=pexdoc tox
GLOB sdist-make: .../pexdoc/setup.py
py27-pkg create: .../pexdoc/.tox/py27
py27-pkg installdeps: -r.../pexdoc/requirements/tests_py27.pip, -r.../pexdoc/requirements/docs_py27.pip
...
  py27-pkg: commands succeeded
  py35-pkg: commands succeeded
  py36-pkg: commands succeeded
  py37-pkg: commands succeeded
  congratulations :)
$

    Setuptools can also be used (Tox is configured as its virtual environment manager):

    $ PKG_NAME=pexdoc python setup.py tests
running tests
running egg_info
writing pexdoc.egg-info/PKG-INFO
writing dependency_links to pexdoc.egg-info/dependency_links.txt
writing requirements to pexdoc.egg-info/requires.txt
...
  py27-pkg: commands succeeded
  py35-pkg: commands succeeded
  py36-pkg: commands succeeded
  py37-pkg: commands succeeded
  congratulations :)
$

    Tox (or Setuptools via Tox) runs with the following default environments: py27-pkg, py35-pkg, py36-pkg and py37-pkg [3]. These use the 2.7, 3.5, 3.6 and 3.7 interpreters, respectively, to test all code in the documentation (both in Sphinx *.rst source files and in docstrings), run all unit tests, measure test coverage and re-build the exceptions documentation. To pass arguments to Pytest (the test runner) use a double dash (--) after all the Tox arguments, for example:

    $ PKG_NAME=pexdoc tox -e py27-pkg -- -n 4
GLOB sdist-make: .../pexdoc/setup.py
py27-pkg inst-nodeps: .../pexdoc/.tox/.tmp/package/1/pexdoc-1.1.4.zip
...
  py27-pkg: commands succeeded
  congratulations :)
$

    Or use the -a Setuptools optional argument followed by a quoted string with the arguments for Pytest. For example:

    $ PKG_NAME=pexdoc python setup.py tests -a "-e py27-pkg -- -n 4"
running tests
...
  py27-pkg: commands succeeded
  congratulations :)
$

    There are other convenience environments defined for Tox [3]:

    • py27-repl, py35-repl, py36-repl and py37-repl run the Python 2.7, 3.5, 3.6 and 3.7 REPL, respectively, in the appropriate virtual environment. The pexdoc package is pip-installed by Tox when the environments are created. Arguments to the interpreter can be passed in the command line after a double dash (--).

    • py27-test, py35-test, py36-test and py37-test run Pytest using the Python 2.7, 3.5, 3.6 and 3.7 interpreter, respectively, in the appropriate virtual environment. Arguments to pytest can be passed in the command line after a double dash (--) , for example:

      $ PKG_NAME=pexdoc tox -e py27-test -- -x test_pexdoc.py
GLOB sdist-make: .../pexdoc/setup.py
py27-pkg inst-nodeps: .../pexdoc/.tox/.tmp/package/1/pexdoc-1.1.4.zip
...
  py27-pkg: commands succeeded
  congratulations :)
$

    • py27-test, py35-test, py36-test and py37-test test code and branch coverage using the 2.7, 3.5, 3.6 and 3.7 interpreter, respectively, in the appropriate virtual environment. Arguments to pytest can be passed in the command line after a double dash (--). The report can be found in ${PEXDOC_DIR}/.tox/py[PV]/usr/share/pe xdoc/tests/htmlcov/index.html where [PV] stands for 2.7, 3.5, 3.6 or 3.7 depending on the interpreter used.

  8. Verify that continuous integration tests pass. The package has continuous integration configured for Linux, Apple macOS and Microsoft Windows (all via Azure DevOps).

  9. Document the new feature or bug fix (if needed). The script ${PEXDOC_DIR}/pypkg/build_docs.py re-builds the whole package documentation (re-generates images, cogs source files, etc.):

    $ "${PEXDOC_DIR}"/pypkg/build_docs.py -h
usage: build_docs.py [-h] [-d DIRECTORY] [-r]
                     [-n NUM_CPUS] [-t]

Build pexdoc package documentation

optional arguments:
  -h, --help            show this help message and exit
  -d DIRECTORY, --directory DIRECTORY
                        specify source file directory
                        (default ../pexdoc)
  -r, --rebuild         rebuild exceptions documentation.
                        If no module name is given all
                        modules with auto-generated
                        exceptions documentation are
                        rebuilt
  -n NUM_CPUS, --num-cpus NUM_CPUS
                        number of CPUs to use (default: 1)
  -t, --test            diff original and rebuilt file(s)
                        (exit code 0 indicates file(s) are
                        identical, exit code 1 indicates
                        file(s) are different)

Footnotes

[1]All examples are for the bash shell
[2]It is assumed that all the Python interpreters are in the executables path. Source code for the interpreters can be downloaded from Python’s main site
[3](1, 2) Tox configuration largely inspired by Ionel’s codelog

Changelog

  • 1.1.4 [2019-03-21]: Dependency fix
  • 1.1.3 [2019-03-21]: Dependency update
  • 1.1.2 [2019-03-21]: Documentation and dependency update
  • 1.1.1 [2019-03-04]: Updated package management framework
  • 1.1.0 [2018-01-19]: Dropped support for Python interpreter versions 2.6, 3.3 and 3.4. Updated dependencies versions to their current versions
  • 1.0.9 [2017-02-10]: Package build enhancements and fixes
  • 1.0.8 [2017-02-07]: Python 3.6 support
  • 1.0.7 [2017-01-02]: Suppressed deprecation warnings for Python 2.6
  • 1.0.6 [2016-06-13]: Fixed Windows continuous integration failure
  • 1.0.5 [2016-06-11]: Minor documentation build bug fix
  • 1.0.4 [2016-05-13]: Documentation update
  • 1.0.3 [2016-05-11]: Documentation update
  • 1.0.2 [2016-05-11]: Documentation update
  • 1.0.1 [2016-05-11]: Documentation update
  • 1.0.0 [2016-05-01]: Final release of 1.0.0 branch
  • 1.0.0rc1 [2016-05-01]: Initial commit, forked a subset from putil PyPI package

License

The MIT License (MIT)

Copyright (c) 2013-2019 Pablo Acosta-Serafini

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.