Skip to content

Commit

Permalink
Merge pull request #127 from Lnaden/copyright-multipy
Browse files Browse the repository at this point in the history
Re-add Python 3.7, update copywrite
  • Loading branch information
Lnaden committed Dec 10, 2020
2 parents 984db1d + b66625e commit e17f22b
Show file tree
Hide file tree
Showing 17 changed files with 46 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_1_1_1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_1_1_2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_1_2_1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_1_2_2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_1_3_1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_1_3_2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_2_1_1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_2_1_2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_2_2_1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_2_2_2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_2_3_1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
2 changes: 1 addition & 1 deletion .github/reference-workflows/CI_2_3_2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/verify-ghas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest, macOS-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]
steps:
- uses: actions/checkout@v1

Expand Down Expand Up @@ -110,7 +110,7 @@ jobs:
strategy: # Approximate strategy, uses a few other options
matrix:
os: [ubuntu-latest , macOS-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]
license: [1] # Nonstandard
rtd: [1, 2] # Nonstandard
steps:
Expand Down Expand Up @@ -179,7 +179,7 @@ jobs:
strategy: # Approximate strategy, uses a few other options
matrix:
os: [ubuntu-latest , macOS-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]
license: [1] # Nonstandard
rtd: [1, 2] # Nonstandard

Expand Down Expand Up @@ -246,7 +246,7 @@ jobs:
strategy: # Approximate strategy, uses a few other options
matrix:
os: [ubuntu-latest , macOS-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]
license: [1] # Nonstandard
rtd: [1, 2] # Nonstandard

Expand Down
37 changes: 26 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ remove deployment platforms, or test with a different suite.

## Requirements

* Python 3.8, or 3.9
* Python 3.7, 3.8, or 3.9
* [Cookiecutter](http://cookiecutter.readthedocs.io/en/latest/installation.html)
* [Git](https://git-scm.com/)

Expand All @@ -45,6 +45,28 @@ package name, author(s), and licences.

[![The cookiecutter in action](http://img.youtube.com/vi/_E7AlaG8zbk/0.jpg)](http://www.youtube.com/watch?v=_E7AlaG8zbk "Computational Molecular Sciences Cookieucutter Example")

## Supported Python Versions
The MolSSI Cookiecutter will strive to support the current version of Python, two minor versions before. This
philosophy is in align with [Conda-Forge's](https://conda-forge.org/docs/orga/guidelines.html#python) guidelines
and gives projects ample time to implement new features.

### When to drop support for older Python versions?

Project developers can freely choose when to drop support for older versions of Python, or if they don't want to support
as many. The general rules we recommend are:
* Support at least two Python versions: The most recent and the preceding minor version. E.g. 3.9 and 3.8
* Dropping Python versions should require a minor Project Version increment.
* New Python versions have been supported for at least one minor revision. E.g Project X.Y
supports Python 3.7 and 3.8; Project X.Y+1 supports Python 3.7, 3.8 and 3.9; Project X.Y+2 supports Python 3.8 and 3.9.
* Add deprecation warnings if features will be removed.

### Why is Python 2.X not on the supported versions?
New projects generally should not be built with Python 2.7 support in mind; see the
[Python 3 Statement](https://python3statement.org/). Although the final Python 2.7 release will be
[supported through 2020](http://legacy.python.org/dev/peps/pep-0373/) and is the default on many legacy systems, Python
3 has been released for almost a decade and a project's long term usage should not be shackled by legacy methods that will
have to be replaced in very short order as Python 2 support is retired.

## Next steps and web integrations
The repository contains a number of "hooks" that integrate with a variety of web services. To fully integrate the project
with these web services and to get started developing your project please proceed through the following directions.
Expand Down Expand Up @@ -175,14 +197,6 @@ origin v0.1`), this tag will then relect in your project: `project.__version__
is 81 commits beyond the version 0.3 tag.


## Why is Python 2.X not on the supported versions?
New projects generally should not be built with Python 2.7 support in mind; see the
[Python 3 Statement](https://python3statement.org/). Although the final Python 2.7 release will be
[supported through 2020](http://legacy.python.org/dev/peps/pep-0373/) and is the default on many legacy systems, Python
3 has been released for almost a decade and a project's long term usage should not be shackled by legacy methods that will
have to be replaced in very short order as Python 2 support is retired.


## Conda and PyPI (`pip`)

Should you deploy and/or develop on [Conda](https://anaconda.org) (with the `conda-build` tool) or [PyPI](https://pypi.org/) (with the `pip` tool)? Good question,
Expand Down Expand Up @@ -342,8 +356,9 @@ upon setup.

## Acknowledgments

This cookiecutter is developed by Levi N. Naden and
Daniel G. A. Smith from the [Molecular Sciences Software Institute (MolSSI)](http://molssi.org/). Copyright (c) 2018-2019.
This cookiecutter is developed by Levi N. Naden and Jessica A. Nash
from the [Molecular Sciences Software Institute (MolSSI)](http://molssi.org/); and
Daniel G. A. Smith of [ENTOS](https://www.entos.ai/). Copyright (c) 2021.

Directory structure template based on recommendation from the
[Chodera Lab's Software Development Guidelines](https://github.com/choderalab/software-development/blob/master/STRUCTURING_YOUR_PROJECT.md).
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
# -- Project information -----------------------------------------------------

project = 'Computational Molecular Sciences Cookiecutter'
copyright = '2018, Levi N. Naden, Daniel G. A. Smith'
author = 'Levi N. Naden, Daniel G. A. Smith'
copyright = '2021, Levi N. Naden, Jessica A. Nash, Daniel G. A. Smith'
author = 'Levi N. Naden, Jessica A. Nash Daniel G. A. Smith'

# The short X.Y version
version = ''
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Additional Pages
Acknowledgments
===============

This cookiecutter is developed by Levi N. Naden and Jessica Nash
This cookiecutter is developed by Levi N. Naden and Jessica A. Nash
from the `Molecular Sciences Software Institute (MolSSI) <http://molssi.org/>`_; and
Daniel G. A. Smith of `ENTOS <https://www.entos.ai/>`_. Copyright (c) 2021.

Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.repo_name}}/.github/workflows/CI.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
strategy:
matrix:
os: [macOS-latest, ubuntu-latest, windows-latest]
python-version: [3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v1
Expand Down

0 comments on commit e17f22b

Please sign in to comment.