Metadata-Version: 2.1
Name: pkg-utils
Version: 0.0.5
Summary: Utilities for linking setuptools with version metadata, README files, requirements files, and restoring overridden entry points
Home-page: https://github.com/KarrLab/pkg_utils
Author: Karr Lab
Author-email: info@karrlab.org
License: MIT
Download-URL: https://github.com/KarrLab/pkg_utils
Keywords: setuptools,pip,requirements,GitHub,pandoc
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Dist: configparser
Requires-Dist: glob2
Requires-Dist: pip (>=19.3)
Requires-Dist: requirements-parser (>=0.2.0)
Requires-Dist: setuptools
Provides-Extra: all
Requires-Dist: pypandoc ; extra == 'all'
Requires-Dist: sphinx (>=1.8) ; extra == 'all'
Requires-Dist: sphinx-fontawesome ; extra == 'all'
Requires-Dist: sphinx-rtd-theme (>=0.4.2) ; extra == 'all'
Requires-Dist: sphinxcontrib-addmetahtml (>=0.1.1) ; extra == 'all'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'all'
Requires-Dist: sphinxcontrib-googleanalytics (>=0.1.1) ; extra == 'all'
Requires-Dist: sphinxcontrib-spelling ; extra == 'all'
Requires-Dist: sphinxprettysearchresults ; extra == 'all'
Provides-Extra: docs
Requires-Dist: sphinx (>=1.8) ; extra == 'docs'
Requires-Dist: sphinx-fontawesome ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (>=0.4.2) ; extra == 'docs'
Requires-Dist: sphinxcontrib-addmetahtml (>=0.1.1) ; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'docs'
Requires-Dist: sphinxcontrib-googleanalytics (>=0.1.1) ; extra == 'docs'
Requires-Dist: sphinxcontrib-spelling ; extra == 'docs'
Requires-Dist: sphinxprettysearchresults ; extra == 'docs'
Provides-Extra: pandoc
Requires-Dist: pypandoc ; extra == 'pandoc'
Provides-Extra: tests

|PyPI package| |Documentation| |Test results| |Test coverage| |Code
analysis| |License| |Analytics|

pkg\_utils
==========

Utilities for linking setuptools with package version metadata, GitHub
README.md files, requirements.txt files, and restoring overridden entry
points during for editable installations. Includes support for optional
dependencies.

Installation
------------

1. Install Python and pip:

   ::

       apt-get install python python-pip

2. Install this package:

   ::

       pip install pkg_utils

3. Optionally, install support for pandoc to link setuptools with GitHub
   markdown formatted README.md files:

   ::

       apt-get install pandoc
       pip install pkg_utils[pandoc]

Documentation
-------------

Please see the `API
documentation <http://docs.karrlab.org/pkg_utils>`__.

License
-------

The build utilities are released under the `MIT license <LICENSE>`__.

Development team
----------------

This package was developed by the `Karr Lab <http://www.karrlab.org>`__
at the Icahn School of Medicine at Mount Sinai in New York, USA.

Questions and comments
----------------------

Please contact the `Karr Lab <http://www.karrlab.org>`__ with any
questions or comments.

.. |PyPI package| image:: https://img.shields.io/pypi/v/pkg_utils.svg
   :target: https://pypi.python.org/pypi/pkg_utils
.. |Documentation| image:: https://readthedocs.org/projects/pkg-utils/badge/?version=latest
   :target: http://docs.karrlab.org/pkg_utils
.. |Test results| image:: https://circleci.com/gh/KarrLab/pkg_utils.svg?style=shield
   :target: https://circleci.com/gh/KarrLab/pkg_utils
.. |Test coverage| image:: https://coveralls.io/repos/github/KarrLab/pkg_utils/badge.svg
   :target: https://coveralls.io/github/KarrLab/pkg_utils
.. |Code analysis| image:: https://api.codeclimate.com/v1/badges/719d7a9027bcdf6a63bc/maintainability
   :target: https://codeclimate.com/github/KarrLab/pkg_utils
.. |License| image:: https://img.shields.io/github/license/KarrLab/pkg_utils.svg
   :target: LICENSE
.. |Analytics| image:: https://ga-beacon.appspot.com/UA-86759801-1/pkg_utils/README.md?pixel



