.. image:: https://raw.githubusercontent.com/benji-york/manuel/master/badges/coverage-badge.svg
:target: https://pypi.python.org/pypi/manuel
.. image:: https://img.shields.io/pypi/pyversions/manuel.svg
:target: https://pypi.python.org/pypi/manuel/
Documentation, a full list of included plug-ins, and examples are available at
`<https://pythonhosted.org/manuel/>`_.
Source code and issues are managed at https://github.com/benji-york/manuel.
Development
===========
To work on Manuel, check out the code and then run `make` to build a development
environment.
To run the tests, run ``make test``. To run all checks, run ``make check``.
See the `Makefile` for more useful targets.
CHANGES
=======
1.13.0 (2024-11-12)
-------------------
- Include*.md files in wheel
These are needed by the test suite, which is also included in the wheel.
- Fix tests on python3.11
- Update some web links
- Update pyinstaller to 6.1.0 for python >= 3.11 support
- doctest: use outputchecker argument also in debug mode.
Fixes #38
- Remove references to old "six" module
1.12.4 (2022-06-24)
-------------------
- Remove silly PyPI version badge.
1.12.3 (2022-06-24)
-------------------
- Modernize internal project structure; drop tox; no user-visible changes (hopefully).
- Rework coverage badge generation.
- Drop Travis CI badge (the project is using GitHub for CI now)
1.11.2 (2022-05-15)
-------------------
Fix missing file in release.
1.11.1 (2022-05-14)
-------------------
Fix brown-bag release.
1.11.0 (2022-05-14)
-------------------
- Fix test detection in Python 2 which was broken since 1.10.0.
(`#20 <https://github.com/benji-york/manuel/issues/20>`_)
- Add Python 3.9 and 3.10 to tox config.
- Add a Makefile to centeralized development activities.
1.10.1 (2018-11-15)
-------------------
- Add support for PyPy3.
1.10.0 (2018-11-14)
-------------------
- Fix DeprecationWarning about 'U' mode under Python 3.
- Drop Python 2.6 and 3.3 support. Add testing and support for Python 3.6 and
3.7.
1.9.0 (2017-11-20)
------------------
- You can now use Manuel with the `nose
<http://nose.readthedocs.io/en/latest/>`_ and `pytest
<https://docs.pytest.org/en/latest/>`_ test runners by defining
Manuel tests inside `unittest.TestCase` classes.
- Added support for Python 3.5 and Python 3.6.
- Dropped support for Python 2.6
1.8.0 (2014-07-15)
------------------
- Fixed ResourceWarnings under Python 3.
- Added support for PyPy and Python 3.4.
- Drop official support for Python 3.1 and 3.2.
- Fix odd ImportError problems when used with tox and coverage.
- Fix parsing of reST codeblock options with hyphens.
1.7.2 (2013-03-16)
------------------
- Fixed release issues.
- Updated copyright and license to reflect recent Zope Foundation release of
claim on the project.
1.7.1 (2013-02-13)
------------------
- Fix brown-bag release.
1.7.0 (2013-02-13)
------------------
- Added support for docutils-style code blocks and options there-of.
1.6.1 (2013-01-24)
------------------
- Fixed a bug that made doctests fail if sys.argv contained the string "-v".
1.6.0 (2012-04-16)
------------------
- Ported to Python 3, still works in 2.6 and up.
1.5.0 (2011-03-08)
------------------
- Removed the dependency on zope.testrunner
- Added the ability to run the tests using "setup.py test".
1.4.1 (2011-01-25)
------------------
- Fixed a bug that caused extra example evaluation if multiple doctest
manuels were used at once (e.g. to execute Python and shell code in
the same document).
1.4.0 (2011-01-11)
------------------
- Added a ``parser`` keyword argument to manuel.doctest.Manuel to
allow a custom doctest parser to be passed in. This allows easily
adding support for other languages or other (but similar) example
syntaxes.
1.3.0 (2010-09-02)
------------------
- Respect test runner reporting switches (e.g., zope.testrunner's --ndiff
switch)
- Fixed a bug that caused post-mortem debugging to not work most of the
time.
- Made manuel.testing.TestCase.id return a sensible textual value
at all times. This keeps Twisted's trial testrunner happy.
1.2.0 (2010-06-10)
------------------
- Conform to repository policy.
- Switch to using zope.testrunner instead of zope.testing due to API changes.
zope.testing is now only required for testing.
1.1.1 (2010-05-20)
------------------
- fix the way globs are handled; fixes
https://bugs.launchpad.net/manuel/+bug/582482
1.1.0 (2010-05-18)
------------------
- fix a SyntaxError when running the tests under Python 2.5
- improved error message for improperly indented capture directive
- Manuel no longer uses the now depricated zope.testing.doctest (requires
zope.testing 3.9.1 or newer)
1.0.5 (2010-01-29)
------------------
- fix a bug that caused Manuel to choke on empty documents (patch submitted by
Bjorn Tillenius)
- add a pointer to Manuel's Subversion repo on the PyPI page
- add an optional parameter that allows a custom TestCase class to be passed to
TestSuite() (patch submitted by Bjorn Tillenius)
1.0.4 (2010-01-06)
------------------
- use newer setuptools (one compatible with Subversion 1.6) so built
distributions include all files
1.0.3 (2010-01-06)
------------------
- fix a small doc thinko
- fix the code-block handler to allow :linenos:
- open files in universal newlines mode
1.0.2 (2009-12-07)
------------------
- fix a bug that caused instances of zope.testing.doctest.Example (and
instances of subclasses of the same) to be silently ignored.
1.0.1 (2009-08-31)
------------------
- fix line number reporting for test failures
1.0.0 (2009-08-09)
------------------
- Python 2.4 compatability fix
1.0.0b2 (2009-07-10)
--------------------
- add the ability to identify and run subsets of documents (using the -t switch
of zope.testing's testrunner for example)
1.0.0b1 (2009-06-24)
--------------------
- major docs improvements
- added several new plug-ins
1.0.0a8 (2009-05-01)
--------------------
- add a larger example of using Manuel (table-example.txt)
- make the test suite factory function try harder to find the calling
module
- fix a bug in the order regions are evaluated
- add a Manuel object that can evaluate Python code in
".. code-block:: python" regions of a reST document
1.0.0a4 (2009-05-01)
--------------------
- make the global state ("globs") shared between all evaluators, not just
doctest
1.0.0a3 (2009-05-01)
--------------------
- make zope.testing's testrunner recognized the enhanced, doctest-style
errors generated by Manuel
- rework the evaluaters to work region-by-region instead of on the
entire document
- switch to using regular Python classes for Manuel objects instead of
previous prototype-y style
1.0.0a2 (2008-10-17)
--------------------
- first release
Raw data
{
"_id": null,
"home_page": "http://pypi.python.org/pypi/manuel",
"name": "manuel",
"maintainer": null,
"docs_url": "https://pythonhosted.org/manuel/",
"requires_python": null,
"maintainer_email": null,
"keywords": "testing, documentation",
"author": "Benji York",
"author_email": "benji@benjiyork.com",
"download_url": "https://files.pythonhosted.org/packages/7b/62/1ae0fc38b62bf720eed970b10c62b608695b34b54436fa223d1c19cc281b/manuel-1.13.0.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/benji-york/manuel/master/badges/coverage-badge.svg\n :target: https://pypi.python.org/pypi/manuel\n\n.. image:: https://img.shields.io/pypi/pyversions/manuel.svg\n :target: https://pypi.python.org/pypi/manuel/\n\nDocumentation, a full list of included plug-ins, and examples are available at\n`<https://pythonhosted.org/manuel/>`_.\n\nSource code and issues are managed at https://github.com/benji-york/manuel.\n\n\nDevelopment\n===========\n\nTo work on Manuel, check out the code and then run `make` to build a development\nenvironment.\n\nTo run the tests, run ``make test``. To run all checks, run ``make check``.\n\nSee the `Makefile` for more useful targets.\n\n\nCHANGES\n=======\n\n1.13.0 (2024-11-12)\n-------------------\n\n- Include*.md files in wheel\n These are needed by the test suite, which is also included in the wheel.\n- Fix tests on python3.11\n- Update some web links\n- Update pyinstaller to 6.1.0 for python >= 3.11 support\n- doctest: use outputchecker argument also in debug mode.\n Fixes #38\n- Remove references to old \"six\" module\n\n\n1.12.4 (2022-06-24)\n-------------------\n\n- Remove silly PyPI version badge.\n\n\n1.12.3 (2022-06-24)\n-------------------\n\n- Modernize internal project structure; drop tox; no user-visible changes (hopefully).\n- Rework coverage badge generation.\n- Drop Travis CI badge (the project is using GitHub for CI now)\n\n\n1.11.2 (2022-05-15)\n-------------------\n\nFix missing file in release.\n\n\n1.11.1 (2022-05-14)\n-------------------\n\nFix brown-bag release.\n\n\n1.11.0 (2022-05-14)\n-------------------\n\n- Fix test detection in Python 2 which was broken since 1.10.0.\n (`#20 <https://github.com/benji-york/manuel/issues/20>`_)\n- Add Python 3.9 and 3.10 to tox config.\n- Add a Makefile to centeralized development activities.\n\n\n1.10.1 (2018-11-15)\n-------------------\n\n- Add support for PyPy3.\n\n\n1.10.0 (2018-11-14)\n-------------------\n\n- Fix DeprecationWarning about 'U' mode under Python 3.\n- Drop Python 2.6 and 3.3 support. Add testing and support for Python 3.6 and\n 3.7.\n\n\n1.9.0 (2017-11-20)\n------------------\n\n- You can now use Manuel with the `nose\n <http://nose.readthedocs.io/en/latest/>`_ and `pytest\n <https://docs.pytest.org/en/latest/>`_ test runners by defining\n Manuel tests inside `unittest.TestCase` classes.\n- Added support for Python 3.5 and Python 3.6.\n- Dropped support for Python 2.6\n\n\n1.8.0 (2014-07-15)\n------------------\n\n- Fixed ResourceWarnings under Python 3.\n- Added support for PyPy and Python 3.4.\n- Drop official support for Python 3.1 and 3.2.\n- Fix odd ImportError problems when used with tox and coverage.\n- Fix parsing of reST codeblock options with hyphens.\n\n\n1.7.2 (2013-03-16)\n------------------\n\n- Fixed release issues.\n- Updated copyright and license to reflect recent Zope Foundation release of\n claim on the project.\n\n\n1.7.1 (2013-02-13)\n------------------\n\n- Fix brown-bag release.\n\n\n1.7.0 (2013-02-13)\n------------------\n\n- Added support for docutils-style code blocks and options there-of.\n\n\n1.6.1 (2013-01-24)\n------------------\n\n- Fixed a bug that made doctests fail if sys.argv contained the string \"-v\".\n\n\n1.6.0 (2012-04-16)\n------------------\n\n- Ported to Python 3, still works in 2.6 and up.\n\n\n1.5.0 (2011-03-08)\n------------------\n\n- Removed the dependency on zope.testrunner\n- Added the ability to run the tests using \"setup.py test\".\n\n\n1.4.1 (2011-01-25)\n------------------\n\n- Fixed a bug that caused extra example evaluation if multiple doctest\n manuels were used at once (e.g. to execute Python and shell code in\n the same document).\n\n\n1.4.0 (2011-01-11)\n------------------\n\n- Added a ``parser`` keyword argument to manuel.doctest.Manuel to\n allow a custom doctest parser to be passed in. This allows easily\n adding support for other languages or other (but similar) example\n syntaxes.\n\n\n1.3.0 (2010-09-02)\n------------------\n\n- Respect test runner reporting switches (e.g., zope.testrunner's --ndiff\n switch)\n- Fixed a bug that caused post-mortem debugging to not work most of the\n time.\n- Made manuel.testing.TestCase.id return a sensible textual value\n at all times. This keeps Twisted's trial testrunner happy.\n\n\n1.2.0 (2010-06-10)\n------------------\n\n- Conform to repository policy.\n- Switch to using zope.testrunner instead of zope.testing due to API changes.\n zope.testing is now only required for testing.\n\n\n1.1.1 (2010-05-20)\n------------------\n\n- fix the way globs are handled; fixes\n https://bugs.launchpad.net/manuel/+bug/582482\n\n\n1.1.0 (2010-05-18)\n------------------\n\n- fix a SyntaxError when running the tests under Python 2.5\n- improved error message for improperly indented capture directive\n- Manuel no longer uses the now depricated zope.testing.doctest (requires\n zope.testing 3.9.1 or newer)\n\n\n1.0.5 (2010-01-29)\n------------------\n\n- fix a bug that caused Manuel to choke on empty documents (patch submitted by\n Bjorn Tillenius)\n- add a pointer to Manuel's Subversion repo on the PyPI page\n- add an optional parameter that allows a custom TestCase class to be passed to\n TestSuite() (patch submitted by Bjorn Tillenius)\n\n\n1.0.4 (2010-01-06)\n------------------\n\n- use newer setuptools (one compatible with Subversion 1.6) so built\n distributions include all files\n\n\n1.0.3 (2010-01-06)\n------------------\n\n- fix a small doc thinko\n- fix the code-block handler to allow :linenos:\n- open files in universal newlines mode\n\n\n1.0.2 (2009-12-07)\n------------------\n\n- fix a bug that caused instances of zope.testing.doctest.Example (and\n instances of subclasses of the same) to be silently ignored.\n\n\n1.0.1 (2009-08-31)\n------------------\n\n- fix line number reporting for test failures\n\n\n1.0.0 (2009-08-09)\n------------------\n\n- Python 2.4 compatability fix\n\n\n1.0.0b2 (2009-07-10)\n--------------------\n\n- add the ability to identify and run subsets of documents (using the -t switch\n of zope.testing's testrunner for example)\n\n\n1.0.0b1 (2009-06-24)\n--------------------\n\n- major docs improvements\n- added several new plug-ins\n\n\n1.0.0a8 (2009-05-01)\n--------------------\n\n- add a larger example of using Manuel (table-example.txt)\n- make the test suite factory function try harder to find the calling\n module\n- fix a bug in the order regions are evaluated\n- add a Manuel object that can evaluate Python code in\n \".. code-block:: python\" regions of a reST document\n\n1.0.0a4 (2009-05-01)\n--------------------\n\n- make the global state (\"globs\") shared between all evaluators, not just\n doctest\n\n\n1.0.0a3 (2009-05-01)\n--------------------\n\n- make zope.testing's testrunner recognized the enhanced, doctest-style\n errors generated by Manuel\n- rework the evaluaters to work region-by-region instead of on the\n entire document\n- switch to using regular Python classes for Manuel objects instead of\n previous prototype-y style\n\n\n1.0.0a2 (2008-10-17)\n--------------------\n\n- first release\n",
"bugtrack_url": null,
"license": "Apache Software License, Version 2.0",
"summary": "Manuel lets you build tested documentation.",
"version": "1.13.0",
"project_urls": {
"Homepage": "http://pypi.python.org/pypi/manuel"
},
"split_keywords": [
"testing",
" documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b621ae0fc38b62bf720eed970b10c62b608695b34b54436fa223d1c19cc281b",
"md5": "42caa321f5244b6ec38da5b9bc440d94",
"sha256": "5d63120de8fa6d927780b69ae28aa3e9d1669b10af3d32785f3fba11a5be885a"
},
"downloads": -1,
"filename": "manuel-1.13.0.tar.gz",
"has_sig": false,
"md5_digest": "42caa321f5244b6ec38da5b9bc440d94",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 46185,
"upload_time": "2024-11-12T12:35:29",
"upload_time_iso_8601": "2024-11-12T12:35:29.916882Z",
"url": "https://files.pythonhosted.org/packages/7b/62/1ae0fc38b62bf720eed970b10c62b608695b34b54436fa223d1c19cc281b/manuel-1.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 12:35:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "manuel"
}
JSON