Merge pull request #22 from sdss/python-template-v2

Python Template v2

Author: albireox

.gitignore

@@ -101,3 +101,7 @@ ENV/
 # mypy
 .mypy_cache/
 
+# Vim temporary files
+*~
+*.swp
+*.swo

CHANGELOG.rst

@@ -6,12 +6,34 @@ Change Log
 
 This document records the main changes to the python-template code.
 
+
 .. _python-template-master:
 
 master
 ------
 
-`View commits since the last tag <https://github.com/sdss/python_template/compare/1.0.6...HEAD>`__.
+`View commits since the last tag <https://github.com/sdss/python_template/compare/2.0.0...HEAD>`__.
+
+
+.. _python-template-2.0.0:
+
+2.0.0 (2020-04-13)
+------------------
+
+Changed
+^^^^^^^
+* Dropped support for Python 2.
+* Move style guide to root level.
+* Use ``setup.cfg`` for packaging and configuration of ``pytest``, ``flake8``, ``isort``, and ``coverage``.
+* Move ``tests`` outside of the package to simplify packaging.
+* Replace ``utils`` with `sdsstools <https://github.com/sdss/sdsstools>`__.
+* Remove use of ``bumpversion``. Instead, get the package version using ``sdsstools.get_package_version``.
+* Updated the template Sphinx docs.
+* Updated style guide and documentation.
+* Allow to choose between setuptools and poetry.
+* Allow to choose between ``sphinx-bootstrap-theme`` and ``alabaster``.
+
+`View commits <https://github.com/sdss/python_template/compare/1.0.6...2.0.0>`__.
 
 
 .. _python-template-1.0.6:

README.md

@@ -1,59 +1,73 @@
 # cookiecutter-python
 
-This is a [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating Python packages that adhere to the [SDSS standard](./\{\{cookiecutter.repo_name\}\}/STYLE.rst).
+This is a [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating Python packages that adhere to the [SDSS standards](./STYLE.rst).
 
 The full documentation on how to use this template can be found [here](http://sdss-python-template.readthedocs.io/en/latest/).
 
+> **WARNING:** version 2 of the Python Template is significantly different from version 1, whose documentation can be found [here](http://sdss-python-template.readthedocs.io/en/latest/v1/v1.html).
+
 ## User Installation
 
 To install and initialize this template:
 
-    pip install invoke
-    pip install bumpversion
-    pip install cookiecutter
-    cookiecutter https://github.com/sdss/python_template.git
+```console
+pip install invoke
+pip install cookiecutter
+cookiecutter https://github.com/sdss/python_template.git
+```
+
+If you want to install [version 1](https://github.com/sdss/python_template/tree/python-template-v1) of the template, you can do:
+
+```console
+cookiecutter https://github.com/sdss/python_template.git --checkout python-template-v1
+```
 
-or to optionally install a specific branch:
+During the installation, you will be asked a series of prompts to specify options and variable names, e.g. your name, the desired package name, etc. These definitions will be inserted into the package in designated places. The final prompts ask
 
-    cookiecutter https://github.com/sdss/python_template.git --checkout [branchname]
+* Do you want to use [setuptools](https://setuptools.readthedocs.io/en/latest/setuptools.html) or [poetry](https://python-poetry.org/) to manage your dependencies?
+* What Sphinx theme do you want to use?
+* Do you want to create a git repository out of your new package?
+* Do you want to connect your new git repo to an account on github?
+
+## What you get in this template
 
-During the installation, you will be asked a series of prompts to specify options and variable names, e.g. your name, the desired package name, etc. These definitions will be inserted into the package in designated places.  The final prompts ask
+* Python 3 compatibility (Python 2 has been dropped as of verson 2 of the template).
+* Pip-ready product.
+* Sphinx Documentation with Read The Docs integration.
+* Pytest testing framework.
+* Improved logging, versioning, and configuration tools using [sdsstools](https://github.com/sdss/sdsstools), as well as commonly used tasks for building the documentation and deploying to PyPI.
+* Continuous Integration with Travis.
+* Code coverage with [codecov](https://codecov.io).
+* Module file.
 
-* do you want to install the new python package with python setup.py install?
-* do you want to create a git repository out of your new package?
-* do you want to connect your new git repo to an account on github?
+## Coding standards
 
+Before you start writing your code, make sure to read and understand the [SDSS coding standards](./\{\{cookiecutter.package_name\}\}/STYLE.rst).
 
 ## Developers
 
 If you are developing on this template, first clone the product:
 
-    git clone https://github.com/sdss/python_template.git
+```console
+git clone https://github.com/sdss/python_template.git
+```
 
-Now edit / add to the code as one normally does.  This package contains a Jinja2 template structure, with variable substitution that occurs upon installation. Variables to be inserted into the template are defined in `cookiecutter.json`.  To reference a variable inside the template structure use the Jinja2 double bracket nomenclature.
+Now edit / add to the code as one normally does. This package contains a Jinja2 template structure, with variable substitution that occurs upon installation. Variables to be inserted into the template are defined in `cookiecutter.json`. To reference a variable inside the template structure use the Jinja2 double bracket nomenclature.
 
-   {{cookiecutter.full_name}}
+```console
+{{cookiecutter.full_name}}
+```
 
 To test install the cookiecutter package locally, run:
 
-    cookiecutter [path_to_my_local_clone_directory]
+```console
+cookiecutter [path_to_my_local_clone_directory]
+```
 
 It is good practice to test install the package locally before you commit any changes to ensure the package can properly install without error.
 
-## What you get in this template
-
-* Python 2/3 compatibility
-* Pip-ready product
-* Sphinx Documentation with Read The Docs integration
-* Pytest Testing Framework
-* Tox for Multiple Python Environment Testing (in a future versions)
-* Improved Logging
-* [Versioning with BumpVersion](https://github.com/peritus/bumpversion)
-* Continuous Integration with Travis
-* Code Coverage with Coveralls
-* Module File
-* Invoke for shell tasks
-
-## Coding standards
+You can also fork this template or create new branches with your specific preferences; then just install it by doing
 
-Before you start writing your code, make sure to read and digest the [SDSS coding standards](./\{\{cookiecutter.repo_name\}\}/STYLE.rst).
+```console
+cookiecutter https://github.com/sdss/python_template.git --checkout <branch>
+```