Metadata-Version: 1.1
Name: putil
Version: 0.9.11
Summary: This library provides a collection of utility modules to supplement the Python standard library
Home-page: http://github.com/pmacosta/putil/
Author: Pablo Acosta-Serafini
Author-email: pmacosta@yahoo.com
License: MIT
Description: .. README.rst
        .. Copyright (c) 2013-2016 Pablo Acosta-Serafini
        .. See LICENSE for details
        
        
        .. image:: https://badge.fury.io/py/putil.svg
            :target: https://pypi.python.org/pypi/putil
            :alt: PyPI version
        
        .. image:: https://img.shields.io/pypi/l/putil.svg
            :target: https://pypi.python.org/pypi/putil
            :alt: License
        
        .. image:: https://img.shields.io/pypi/pyversions/putil.svg
            :target: https://pypi.python.org/pypi/putil
            :alt: Python versions supported
        
        .. image:: https://img.shields.io/pypi/format/putil.svg
            :target: https://pypi.python.org/pypi/putil
            :alt: Format
        
        |
        
        .. image::
           https://travis-ci.org/pmacosta/putil.svg?branch=master
        
        .. image::
           https://ci.appveyor.com/api/projects/status/
           7dpk342kxs8kcg5t/branch/master?svg=true
           :alt: Windows continuous integration
        
        .. image::
           https://codecov.io/github/pmacosta/putil/coverage.svg?branch=master
           :target: https://codecov.io/github/pmacosta/putil?branch=master
           :alt: Continuous integration coverage
        
        .. image::
           https://readthedocs.org/projects/pip/badge/?version=stable
           :target: http://pip.readthedocs.org/en/stable/?badge=stable
           :alt: Documentation status
        
        |
        
        Putil Library
        =============
        
        .. role:: bash(code)
        	:language: bash
        
        .. [[[cog
        .. import os, sys
        .. from docs.support.term_echo import ste
        .. file_name = sys.modules['docs.support.term_echo'].__file__
        .. mdir = os.path.realpath(
        ..     os.path.dirname(os.path.dirname(os.path.dirname(file_name)))
        .. )
        .. import docs.support.requirements_to_rst
        .. docs.support.requirements_to_rst.def_links(cog)
        .. ]]]
        .. _Astroid: https://bitbucket.org/logilab/astroid
        .. _Cog: http://nedbatchelder.com/code/cog
        .. _Coverage: http://coverage.readthedocs.org/en/coverage-4.0a5
        .. _Decorator: https://pythonhosted.org/decorator
        .. _Docutils: http://docutils.sourceforge.net/docs
        .. _Funcsigs: https://pypi.python.org/pypi/funcsigs
        .. _Matplotlib: http://matplotlib.org
        .. _Mock: http://www.voidspace.org.uk/python/mock
        .. _Nose: http://nose.readthedocs.org
        .. _Numpy: http://www.numpy.org
        .. _Pillow: https://python-pillow.github.io
        .. _PyContracts: https://andreacensi.github.io/contracts
        .. _Pylint: http://www.pylint.org
        .. _Py.test: http://pytest.org
        .. _Pytest-coverage: https://pypi.python.org/pypi/pytest-cov
        .. _Pytest-xdist: https://pypi.python.org/pypi/pytest-xdist
        .. _Scipy: http://www.scipy.org
        .. _Six: https://pythonhosted.org/six
        .. _Sphinx: http://sphinx-doc.org
        .. _ReadTheDocs Sphinx theme: https://github.com/snide/sphinx_rtd_theme
        .. _Inline Syntax Highlight Sphinx Extension:
           https://bitbucket.org/klorenz/sphinxcontrib-inlinesyntaxhighlight
        .. _Tox: https://testrun.org/tox
        .. _Virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs
        .. [[[end]]]
        
        This library provides a collection of utility modules to supplement the
        Python standard library. The modules provided are:
        
        * **eng**: engineering-related functions including a) handling numbers
          represented in engineering notation, obtaining their constituent
          components and converting to and from regular floats; b) pretty printing
          Numpy vectors; and c) formatting numbers represented in scientific
          notation with a greater degree of control and options than standard
          Python string formatting
        
        * **exdoc**: automatically generate exceptions documentation marked up in
          `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ with help from
          `Cog`_ and the exh module
        
        * **exh**: register exceptions and then raise them if a given condition is true
        
        * **misc**: miscellaneous utility functions that can be applied in a variety
          of circumstances; there are context managers, membership functions (test if
          an argument is of a given type), numerical functions and string functions
        
        * **pcontracts**: thin wrapper around the
          `PyContracts`_ library that
          enables customization of the exception type raised and limited
          customization of the exception message
        
        * **pcsv**: handle comma-separated values (CSV) files and do lightweight
          processing of their data
        
        * **pinspect**: supplement Python's introspection capabilities
        
        * **plot**: create high-quality, presentation-ready X-Y graphs quickly and
          easily
        
        * **ptypes**: several pseudo-type definitions which can be enforced
          and/or validated with custom contracts defined using the
          pcontracts module
        
        * **test**: functions to aid in the unit testing of modules in the package
          (`Py.test`_-based)
        
        * **tree**: build, handle, process and search
          `tries <http://wikipedia.org/wiki/Trie>`_
        
        Interpreter
        ===========
        
        The package has been developed and tested with Python 2.6, 2.7, 3.3, 3.4
        and 3.5 under Linux (Debian, Ubuntu), Apple OS X and Microsoft Windows
        
        Installing
        ==========
        
        .. code-block:: bash
        
        	$ pip install putil
        
        Documentation
        =============
        
        Available at `Read the Docs <https://putil.readthedocs.org>`_
        
        Contributing
        ============
        
        1. Abide by the adopted `code of conduct
           <http://contributor-covenant.org/version/1/3/0>`_
        
        2. Fork the `repository <https://github.com/pmacosta/putil>`_ from
           GitHub and then clone personal copy [#f1]_:
        
        	.. code-block:: bash
        
        		$ git clone \
        		      https://github.com/[github-user-name]/putil.git
                        Cloning into 'putil'...
                        ...
        		$ cd putil
        		$ export PUTIL_DIR=${PWD}
        
        3. Install the project's Git hooks and build the documentation. The pre-commit
           hook does some minor consistency checks, namely trailing whitespace and
           `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_ compliance via
           Pylint. Assuming the directory to which the repository was cloned is
           in the :bash:`$PUTIL_DIR` shell environment variable:
        
        	.. code-block:: bash
        
        		$ ${PUTIL_DIR}/sbin/complete-cloning.sh
                        Installing Git hooks
                        Building putil package documentation
                        ...
        
        4. Ensure that the Python interpreter can find the package modules
           (update the :bash:`$PYTHONPATH` environment variable, or use
           `sys.paths() <https://docs.python.org/2/library/sys.html#sys.path>`_,
           etc.)
        
        	.. code-block:: bash
        
        		$ export PYTHONPATH=${PYTHONPATH}:${PUTIL_DIR}
        
        5. Install the dependencies (if needed, done automatically by pip):
        
            .. [[[cog
            .. import docs.support.requirements_to_rst
            .. docs.support.requirements_to_rst.proc_requirements(cog)
            .. ]]]
        
        
            * `Astroid`_ (Python 2.6: older than 1.4, Python 2.7 or newer: 1.3.8
              or newer)
        
            * `Cog`_ (2.4 or newer)
        
            * `Coverage`_ (3.7.1 or newer)
        
            * `Decorator`_ (3.4.2 or newer)
        
            * `Docutils`_ (0.12 or newer)
        
            * `Funcsigs`_ (Python 2.x only, 0.4 or newer)
        
            * `Inline Syntax Highlight Sphinx Extension`_ (0.2 or newer)
        
            * `Matplotlib`_ (1.4.1 or newer)
        
            * `Mock`_ (Python 2.x only, 1.0.1 or newer)
        
            * `Nose`_ (Python 2.6: 1.0.0 or newer)
        
            * `Numpy`_ (1.8.2 or newer)
        
            * `Pillow`_ (2.6.1 or newer)
        
            * `Py.test`_ (2.7.0 or newer)
        
            * `PyContracts`_ (1.7.2 or newer except 1.7.7)
        
            * `Pylint`_ (Python 2.6: 1.3 or newer and older than 1.4, Python 2.7
              or newer: 1.3.1 or newer)
        
            * `Pytest-coverage`_ (1.8.0 or newer)
        
            * `Pytest-xdist`_ (optional, 1.8.0 or newer)
        
            * `ReadTheDocs Sphinx theme`_ (0.1.9 or newer)
        
            * `Scipy`_ (0.13.3 or newer)
        
            * `Six`_ (1.4.0 or newer)
        
            * `Sphinx`_ (1.2.3 or newer)
        
            * `Tox`_ (1.9.0 or newer)
        
            * `Virtualenv`_ (13.1.2 or newer)
        
            .. [[[end]]]
        
        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 Py.test:
        
        	.. code-block:: bash
        
                    $ tox
                    GLOB sdist-make: .../putil/setup.py
                    py26-pkg inst-nodeps: .../putil/.tox/dist/putil-...zip
        
           `Setuptools <https://bitbucket.org/pypa/setuptools>`_ can also be used
           (Tox is configured as its virtual environment manager) [#f2]_:
        
        	.. code-block:: bash
        
        	    $ python setup.py tests
                    running tests
                    running egg_info
                    writing requirements to putil.egg-info/requires.txt
                    writing putil.egg-info/PKG-INFO
                    ...
        
           Tox (or Setuptools via Tox) runs with the following default environments:
           ``py26-pkg``, ``py27-pkg``, ``py33-pkg``, ``py34-pkg`` and ``py35-pkg``
           [#f3]_. These use the Python 2.6, 2.7, 3.3, 3.4 and 3.5 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
           Py.test (the test runner) use a double dash (``--``) after all the Tox
           arguments, for example:
        
        	.. code-block:: bash
        
        	    $ tox -e py27-pkg -- -n 4
                    GLOB sdist-make: .../putil/setup.py
                    py27-pkg inst-nodeps: .../putil/.tox/dist/putil-...zip
                    ...
        
           Or use the :code:`-a` Setuptools optional argument followed by a quoted
           string with the arguments for Py.test. For example:
        
        	.. code-block:: bash
        
        	    $ python setup.py tests -a "-e py27-pkg -- -n 4"
                    running tests
                    ...
        
           There are other convenience environments defined for Tox [#f4]_:
        
            * ``py26-repl``, ``py27-repl``, ``py33-repl``, ``py34-repl`` and
              ``py35-repl`` run the Python 2.6, 2.7, 3.3, 3.4 or 3.5 REPL,
              respectively, in the appropriate virtual environment. The ``putil``
              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 (``--``)
        
            * ``py26-test``, ``py27-test``, ``py33-test``, ``py34-test`` and
              ``py35-test`` run py.test using the Python 2.6, 2.7, 3.3, 3.4
              or Python 3.5 interpreter, respectively, in the appropriate virtual
              environment. Arguments to py.test can be passed in the command line
              after a double dash (``--``) , for example:
        
        	.. code-block:: bash
        
        	    $ tox -e py34-test -- -x test_eng.py
                    GLOB sdist-make: [...]/putil/setup.py
                    py34-test inst-nodeps: [...]/putil/.tox/dist/putil-[...].zip
                    py34-test runtests: PYTHONHASHSEED='680528711'
                    py34-test runtests: commands[0] | [...]py.test -x test_eng.py
                    ==================== test session starts ====================
                    platform linux -- Python 3.4.2 -- py-1.4.30 -- [...]
                    ...
        
            * ``py26-cov``, ``py27-cov``, ``py33-cov``, ``py34-cov`` and
              ``py35-cov`` test code and branch coverage using the Python 2.6,
              2.7, 3.3, 3.4 or 3.5 interpreter, respectively, in the appropriate
              virtual environment. Arguments to py.test can be passed in the command
              line after a double dash (``--``). The report can be found in
              :bash:`${PUTIL_DIR}/.tox/py[PV]/usr/share/putil/tests/htmlcov/index.html`
              where ``[PV]`` stands for ``26``, ``27``, ``33``, ``34`` or ``35``
              depending on the interpreter used
        
        8. Verify that continuous integration tests pass. The package has continuous
           integration configured for Linux (via `Travis <http://www.travis-ci.org>`_)
           and for Microsoft Windows (via `Appveyor <http://www.appveyor.com>`_).
           Aggregation/cloud code coverage is configured via
           `Codecov <https://codecov.io>`_. It is assumed that the Codecov repository
           upload token in the Travis build is stored in the :bash:`${CODECOV_TOKEN}`
           environment variable (securely defined in the Travis repository settings
           page). Travis build artifacts can be transferred to Dropbox using the
           `Dropbox Uploader <https://github.com/andreafabrizi/Dropbox-Uploader>`_
           script (included for convenience in the :bash:`${PUTIL_DIR}/sbin` directory).
           For an automatic transfer that does not require manual entering of
           authentication credentials place the APPKEY, APPSECRET, ACCESS_LEVEL,
           OAUTH_ACCESS_TOKEN and OAUTH_ACCESS_TOKEN_SECRET values required by
           Dropbox Uploader in the in the :bash:`${DBU_APPKEY}`,
           :bash:`${DBU_APPSECRET}`, :bash:`${DBU_ACCESS_LEVEL}`,
           :bash:`${DBU_OAUTH_ACCESS_TOKEN}` and
           :bash:`${DBU_OAUTH_ACCESS_TOKEN_SECRET}` environment variables,
           respectively (also securely defined in Travis repository settings page)
        
        
        9. Document the new feature or bug fix (if needed). The script
           :bash:`${PUTIL_DIR}/sbin/build_docs.py` re-builds the whole package
           documentation (re-generates images, cogs source files, etc.):
        
        	.. [[[cog ste('build_docs.py -h', 0, mdir, cog.out) ]]]
        
        	.. code-block:: bash
        
        	    $ ${PUTIL_DIR}/sbin/build_docs.py -h
        	    usage: build_docs.py [-h] [-d DIRECTORY] [-r]
        	                         [-n NUM_CPUS] [-t]
        	                         [module_name [module_name ...]]
        
        	    Build putil package documentation
        
        	    positional arguments:
        	      module_name           Module name for which to build
        	                            documentation for
        
        	    optional arguments:
        	      -h, --help            show this help message and exit
        	      -d DIRECTORY, --directory DIRECTORY
        	                            specify source file directory
        	                            (default ../putil)
        	      -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)
        
        
        	.. [[[end]]]
        
            Output of shell commands can be automatically included in reStructuredText
            source files with the help of Cog_ and the :code:`docs.support.term_echo` module.
        
        
        
            Similarly Python files can be included in docstrings with the help of Cog_
            and the :code:`docs.support.incfile` module
        
        
        .. rubric:: Footnotes
        
        .. [#f1] All examples are for the `bash <https://www.gnu.org/software/bash/>`_
           shell
        
        .. [#f2] It appears that Scipy dependencies do not include Numpy (as they
           should) so running the tests via Setuptools will typically result in an
           error. The putil requirement file specifies Numpy before Scipy and this
           installation order is honored by Tox so running the tests via Tox sidesteps
           Scipy's broken dependency problem but requires Tox to be installed before
           running the tests (Setuptools installs Tox if needed)
        
        .. [#f3] 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 <http://www.python.org/downloads>`_
        
        .. [#f4] Tox configuration largely inspired by
           `Ionel's codelog <http://blog.ionelmc.ro/2015/04/14/
           tox-tricks-and-patterns/>`_
        
        
        License
        =======
        
        The MIT License (MIT)
        
        Copyright (c) 2013-2016 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.
        .. CHANGELOG.rst
        .. Copyright (c) 2013-2016 Pablo Acosta-Serafini
        .. See LICENSE for details
        
        Changelog
        =========
        
        * 0.9.11 [2016-04-15]:
        
          * Created new APIs in the exh module to simplify adding and conditionally
            raising exceptions that can be auto-documented with the exdoc module
        
          * Homogenized API arguments in several pcsv module functions
        
          * Bug fixes
        
          * Documentation updates
        
        * 0.9.10 [2016-03-10]: Final release of 0.9.10 branch
        * 0.9.10rc1 [2016-03-09]: Apple OS X compatibility changes. Reduced memory
          consumption during exception auto-documentation process. Bug fixes
        * 0.9.9 [2016-01-27]: Fixed documentation bugs that were causing errors with
          Sphinx 1.3.5+
        * 0.9.8 [2016-01-22]: Bug fixes
        * 0.9.7 [2016-01-22]: Enhanced control of exceptions automatic documentation
          output
        * 0.9.6 [2016-01-20]: Bug fixes
        * 0.9.5 [2016-01-08]: Bug fixes
        * 0.9.4 [2015-12-18]: Minor documentation update regarding continuous
          integration setup
        * 0.9.3 [2015-12-17]: Fixed critical bug in plot module that prevented figures
          without any axis labels from being generated
        * 0.9.2 [2015-12-15]: Speed improvements in plot module
        * 0.9.1 [2015-12-01]: Final release of 0.9.1 branch
        * 0.9.1rc5 [2015-12-01]: Fixed documentation URL in top-level README.rst
        * 0.9.1rc4 [2015-12-01]: Fixed bug in top-level README.rst verification
        * 0.9.1rc3 [2015-12-01]:
        
          * Documentation updates
        
          * Package verification improvements
        
        * 0.9.1rc2 [2015-12-01]: Fixed top-level README.rst file
        * 0.9.1rc1 [2015-11-30]: Initial public release
        
Platform: any
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
