https://github.com/karrlab/pkg_utils

Utilities for packaging Python code
https://github.com/karrlab/pkg_utils

packaging pip requirements setuptools

Last synced: 10 months ago
JSON representation

Utilities for packaging Python code

• Host: GitHub
• URL: https://github.com/karrlab/pkg_utils
• Owner: KarrLab
• License: mit
• Created: 2017-12-03T17:58:11.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-26T19:45:40.000Z (almost 6 years ago)
• Last Synced: 2025-06-24T21:46:28.129Z (10 months ago)
• Topics: packaging, pip, requirements, setuptools
• Language: Python
• Homepage:
• Size: 80.1 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![PyPI package](https://img.shields.io/pypi/v/pkg_utils.svg)](https://pypi.python.org/pypi/pkg_utils)

[![Documentation](https://readthedocs.org/projects/pkg-utils/badge/?version=latest)](http://docs.karrlab.org/pkg_utils)

[![Test results](https://circleci.com/gh/KarrLab/pkg_utils.svg?style=shield)](https://circleci.com/gh/KarrLab/pkg_utils)

[![Test coverage](https://coveralls.io/repos/github/KarrLab/pkg_utils/badge.svg)](https://coveralls.io/github/KarrLab/pkg_utils)

[![Code analysis](https://api.codeclimate.com/v1/badges/719d7a9027bcdf6a63bc/maintainability)](https://codeclimate.com/github/KarrLab/pkg_utils)

[![License](https://img.shields.io/github/license/KarrLab/pkg_utils.svg)](LICENSE)

![Analytics](https://ga-beacon.appspot.com/UA-86759801-1/pkg_utils/README.md?pixel)

# 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.