API Documentation

Warning

Note that astropy-helpers is deprecated. As justified and described in APE17, the astropy-helpers infrastructure is no longer used for Astropy coordinated or infrastructure packages, and hence is no longer maintained.

astropy_helpers.setup_helpers Module

Functions

register_commands([package, version, ...])

This function generates a dictionary containing customized commands that can then be passed to the cmdclass argument in setup().

get_package_info([srcdir, exclude])

Collates all of the information for building all subpackages and returns a dictionary of keyword arguments that can be passed directly to distutils.setup.

astropy_helpers.version_helpers Module

Functions

generate_version_py([packagename, version, ...])

Generate a version.py file in the package with version information, and update developer version strings.

astropy_helpers.openmp_helpers Module

Functions

add_openmp_flags_if_available(extension)

Add OpenMP compilation flags, if supported (if not a warning will be printed to the console and no flags will be added.)

astropy_helpers.git_helpers Module

Functions

get_git_devstr([sha, show_warning, path])

Determines the number of revisions in this repository.