4. pkg_utils package

4.1. Submodules

4.2. pkg_utils.core module

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

Author:Jonathan Karr <jonrkarr@gmail.com>
Date:2017-12-03
Copyright:2017, Karr Lab
License:MIT
class pkg_utils.core.PackageMetadata[source]

Bases: object

Metadata about a package

name[source]

str

description[source]

str – short description

long_description[source]

str – long description, e.g. from README.rst

version[source]

str – version, e.g. from package/VERSION

install_requires[source]

list of str – dependencies, e.g. from requirements.txt

extras_require[source]

dict of list of str – optional dependencies, e.g. from requirements.optional.txt

tests_require[source]

list of str – test dependencies, e.g. from tests/requirements.txt

list of str – documentation dependencies, e.g. from docs/requirements.txt

pkg_utils.core.add_console_scripts(dirname, package_name, console_scripts)[source]

Add console scripts for a package

Parameters:
  • dirname (str) – path to the package
  • package_name (str) – package name
  • console_scripts (dict) – console script names and locations
pkg_utils.core.convert_readme_md_to_rst(dirname)[source]

Convert the README.md to README.rst

Parameters:dirname (str) – path to the package
pkg_utils.core.get_console_scripts(dirname, package_name)[source]

Get the console scripts for a package

Parameters:
  • dirname (str) – path to the package
  • package_name (str) – package name
Returns:

console script names and locations
Return type:

dict
pkg_utils.core.get_long_description(dirname)[source]

Get the long description of a package from its README.rst file

Parameters:dirname (str) – path to the package
Returns:long description
Return type:str
pkg_utils.core.get_package_metadata(dirname, package_name)[source]

Get meta data about a package

Parameters:
  • dirname (str) – path to the package
  • package_name (str) – package name
Returns:

meta data
Return type:

PackageMetadata
Raises:

Exception: if test or documentation dependencies are defined in requirements.optional.txt
pkg_utils.core.get_version(dirname, package_name)[source]

Get the version a package from its VERSION file (package/VERSION)

Parameters:
  • dirname (str) – path to the package
  • package_name (str) – package name
Returns:

version
Return type:

str
pkg_utils.core.install_dependencies(dependencies, upgrade=False)[source]

Install dependencies

Parameters:
  • dependencies (list) – list of dependencies
  • upgrade (bool, optional) – if True, upgrade package
pkg_utils.core.parse_optional_requirements_file(filename)[source]

Parse a requirements.optional.txt file into list of requirements and dependency links

Parameters:filename (str) – path to requirements.txt file
Returns:requirements list of str: dependency links
Return type:dict of list of str
Raises:Exception – if a line cannot be parsed
pkg_utils.core.parse_requirement_lines(lines)[source]

Parse lines from a requirements.txt file into list of requirements and dependency links

Parameters:lines (list of str) – lines from a requirements.txt file
Returns:requirements list of str of str: dependency links
Return type:list of str
Raises:Exception – if a line cannot be parse
pkg_utils.core.parse_requirements_file(filename)[source]

Parse a requirements.txt file into list of requirements and dependency links

Parameters:filename (str) – path to requirements.txt file
Returns:requirements list of str: dependency links
Return type:list of str

4.3. Module contents