Repository files navigation

This template is deprecated in favor ofOpenAstronomy packaging guide,which reflects more up-to-date Python packaging techniques. Inthe future, this template will be replaced by a guide built from the OA guide specificto Astropy, but in the meantime, if you are starting a new project you may wish tostart from the OA guide.

cookiecutter branch:

This is a package template provided by the Astropy project.

Using this template, packages can make use of the setup, installation, and documentationinfrastructure developed for theastropy core and affiliated packages.

For more information, see:

• Thedocumentation for this package template itself
• Astropydocumentation about this template
• The Affiliated Packages section of the Astropy web site
• This template's Github code repository

This package template makes use of thecookiecutter package tomake it easier to get started with the package template. You will need toinstall cookiecutter whichcan be done easily using conda or pip:

conda install -c conda-forge cookiecutter gitpythonpip install cookiecutter gitpython

Once you have cookiecutter installed you can run:

cookiecutter gh:astropy/package-template

Which will ask you a series of questions to configure your package.

Themaster git branch of this repository contains a version of thetemplate populated with placeholders. This allows the package template to beused directly without using cookiecutter, although a number ofmanual stepsare required. For this reason the cookiecutter approach is recommended.

If you want to modify this package template to add or fix things, the folder thatthe user ends up with is{{ cookiecutter.package_name }} in thisrepository. Everything in the repository that is not in this folder is not partof the template that the user will have rendered.

For further information on writing templates for cookiecutter seethe cookiecutter docs.