Metadata-Version: 2.1
Name: pyhelpers
Version: 1.4.1
Summary: An open-source toolkit for facilitating Python users' data manipulation tasks.
Home-page: https://github.com/mikeqfu/pyhelpers
Author: Qian Fu
Author-email: q.fu@bham.ac.uk
License: GPLv3+
Project-URL: Documentation, https://pyhelpers.readthedocs.io/en/1.4.1/
Project-URL: Source, https://github.com/mikeqfu/pyhelpers
Project-URL: Bug Tracker, https://github.com/mikeqfu/pyhelpers/issues
Keywords: Python,Utilities,Data preprocessing,Data manipulation
Platform: nt
Platform: posix
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE

#########
PyHelpers
#########

|Python| |Documentation| |License| |Codacy grade| |DOI|

.. |Python| image:: https://img.shields.io/pypi/pyversions/pyhelpers
    :alt: Python version
    :target: https://docs.python.org/3/
.. |Documentation| image:: https://readthedocs.org/projects/pyhelpers/badge/?version=latest
    :alt: Documentation status
    :target: https://pyhelpers.readthedocs.io/en/latest/?badge=latest
.. |License| image:: https://img.shields.io/pypi/l/pyhelpers
    :alt: License
    :target: https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE
.. |Codacy grade| image:: https://app.codacy.com/project/badge/Grade/c3ed8571c494450da12cb0c4d3c8c7e9
    :alt: Codacy grade (Code quality)
    :target: https://www.codacy.com/gh/mikeqfu/pyhelpers/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mikeqfu/pyhelpers&amp;utm_campaign=Badge_Grade
.. |DOI| image:: https://zenodo.org/badge/173177909.svg
    :alt: Zenodo - DOI
    :target: https://zenodo.org/badge/latestdoi/173177909

PyHelpers is an open-source Python package designed as a lite toolkit for facilitating data (pre)processing. It offers a miscellaneous collection of handy utilities, which could assist us in performing many common data manipulation tasks, such as reading/writing of file-like objects, handling of various types of data (e.g. geographical data and textual data) and communication with relational databases (e.g. PostgreSQL and Microsoft SQL Server).

Installation
############

To install the latest release of pyhelpers from `PyPI <https://pypi.org/project/pyhelpers/>`_ via `pip <https://pip.pypa.io/en/stable/cli/pip/>`_:

.. code-block:: bash

    pip install --upgrade pyhelpers

For more information, please refer to `Installation <https://pyhelpers.readthedocs.io/en/latest/installation.html>`_.

Documentation
#############

The full PyHelpers documentation (including detailed examples and a quick-start tutorial) is hosted on `ReadTheDocs <https://readthedocs.org/projects/pyhelpers/>`_: [`HTML <https://pyhelpers.readthedocs.io/en/latest/>`_] [`PDF <https://pyhelpers.readthedocs.io/_/downloads/en/latest/pdf/>`_].

License
#######

PyHelpers is licensed under `GNU General Public License v3 <https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE>`_ or later (GPLv3+).

Cite as
#######

Fu, Q. (2020). PyHelpers: an open-source toolkit for facilitating Python users' data manipulation tasks. Zenodo. `doi:10.5281/zenodo.4017438 <https://doi.org/10.5281/zenodo.4017438>`_

.. code-block:: bibtex

    @software{qian_fu_pyhelpers_4017438,
      author    = {Qian Fu},
      title     = {{PyHelpers: an open-source toolkit for facilitating
                    Python users' data manipulation tasks}},
      year      = 2020,
      publisher = {Zenodo},
      doi       = {10.5281/zenodo.4017438},
      url       = {https://doi.org/10.5281/zenodo.4017438}
    }

**Note:** Please also refer to the export options from `Zenodo <https://zenodo.org/search?page=1&size=20&q=conceptrecid:%224017438%22&sort=-version&all_versions=True>`_ to reference the specific version as appropriate when using PyHelpers.
