This repository is archived. Use it at your own risk. We apologize for any inconvenience caused.
Note: astropy-helpers is deprecated. As justified and described in
APE17 <https://github.com/astropy/astropy-APEs/blob/main/APE17.rst>_,
the astropy-helpers infrastructure is no longer used for Astropy coordinated or infrastructure
packages, and hence is no longer maintained.
.. image:: https://travis-ci.org/astropy/astropy-helpers.svg :target: https://travis-ci.org/astropy/astropy-helpers
.. image:: https://ci.appveyor.com/api/projects/status/rt9161t9mhx02xp7/branch/master?svg=true :target: https://ci.appveyor.com/project/Astropy/astropy-helpers
.. image:: https://codecov.io/gh/astropy/astropy-helpers/branch/master/graph/badge.svg :target: https://codecov.io/gh/astropy/astropy-helpers
The astropy-helpers package includes many build, installation, and
documentation-related tools used by the Astropy project, but packaged separately
for use by other projects that wish to leverage this work. The motivation behind
this package and details of its implementation are in the accepted
Astropy Proposal for Enhancement (APE) 4 <https://github.com/astropy/astropy-APEs/blob/master/APE4.rst>_.
Astropy-helpers is not a traditional package in the sense that it is not
intended to be installed directly by users or developers. Instead, it is meant
to be accessed when the setup.py command is run - see the
"Using astropy-helpers in a package <https://astropy-helpers.readthedocs.io/en/stable/using.html>"
section in the documentation for how to do this.
For a real-life example of how to implement astropy-helpers in a
project, see the setup.py and setup.cfg files of the
Affiliated package template <https://github.com/astropy/package-template>.
For more information, see the documentation at http://astropy-helpers.readthedocs.io