Merge remote-tracking branch 'origin/main' into 235-zenodo-integration

Author: fdiblen

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-latest', 'macos-latest']
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
         python-version: ['3.6', '3.7', '3.8', '3.9']
     steps:
     - uses: actions/checkout@v2

README.md

@@ -61,6 +61,8 @@ cookiecutter https://github.com/nlesc/python-template.git
 | package_name              | my_python_package | Name of the package. Avoid using spaces, dashes, or uppercase letters for the best experience across operating systems. |
 | project_name              | my-python-project | Name of the project that contains the package. Avoid using spaces or uppercase letters for the best experience across operating systems. |
 | package_short_description |              | The information that you enter here will end up in the README, documentation, license, and setup.cfg, so it may be a good idea to prepare something in advance. |
+| keyword1                  | keyword1          | A term that describes your package. |
+| keyword2                  | keyword2          | Another term that describes your package. |
 | version                   | 0.1.0             |   |
 | github_organization       | <my-github-organization> | GitHub organization that will contain this project's repository. This can also be your GitHub user name. |
 | license                   | Apache Software License 2.0 | The software license under which the code is made available.  |

cookiecutter.json

@@ -3,6 +3,8 @@
   "project_name": "my-python-project",
   "_copy_without_render": [".github/workflows/*"],
   "package_short_description": "",
+  "keyword1": "keyword1",
+  "keyword2": "keyword2",
   "version": "0.1.0",
   "github_organization": "<my-github-organization>",
   "license": ["Apache Software License 2.0", "MIT license", "BSD license", "ISC license", "GNU General Public License v3 or later", "Not open source"],

tests/test_project.py

@@ -1,10 +1,15 @@
 import os
 import subprocess
+from pathlib import Path
+from shutil import which
 from sys import platform
 from typing import Sequence
 
 import pytest
 
+IS_WINDOWS = platform.startswith("win")
+IS_WINDOWS_CI = IS_WINDOWS and os.environ.get('CI', False)
+
 
 def test_project_folder(cookies):
     project = cookies.bake()
@@ -16,37 +21,46 @@ def test_project_folder(cookies):
 
 
 def run(args: Sequence[str], dirpath: os.PathLike) -> subprocess.CompletedProcess:
-    return subprocess.run(args=args,
-                          stdout=subprocess.PIPE,
-                          stderr=subprocess.PIPE,
-                          cwd=dirpath,
-                          encoding="utf-8")
+    completed_process = subprocess.run(args=args,
+                                       stdout=subprocess.PIPE,
+                                       stderr=subprocess.PIPE,
+                                       cwd=dirpath,
+                                       encoding="utf-8")
+    print(completed_process.stdout)
+    print(completed_process.stderr)
+    return completed_process
 
 
 @pytest.fixture
 def baked_with_development_dependencies(cookies):
     result = cookies.bake()
-    env_output = run(['python3', '-m', 'venv', 'env'], result.project)
-    assert env_output.returncode == 0
-    env_bin = 'env/Scripts/' if platform.startswith("win") else 'env/bin/'
-    latest_pip_output = run([f'{env_bin}pip3', 'install', '--upgrade', 'pip', 'setuptools'], result.project)
+    if IS_WINDOWS_CI:
+        # Creating virtualenv does not work on Windows CI,
+        # falling back to using current pip3 dir
+        pip = Path(which('pip3'))
+        bin_dir = str(pip.parent) + '\\'
+    else:
+        env_output = run(['python3', '-m', 'venv', 'env'], result.project)
+        assert env_output.returncode == 0
+        bin_dir = 'env/Scripts/' if IS_WINDOWS else 'env/bin/'
+    latest_pip_output = run([f'{bin_dir}pip3', 'install', '--upgrade', 'pip', 'setuptools'], result.project)
     assert latest_pip_output.returncode == 0
-    pip_output = run([f'{env_bin}pip3', 'install', '--editable', '.[dev]'], result.project)
+    pip_output = run([f'{bin_dir}pip3', 'install', '--editable', '.[dev]'], result.project)
     assert pip_output.returncode == 0
-    return result.project, env_bin
+    return result.project, bin_dir
 
 
 def test_pytest(baked_with_development_dependencies):
-    project_dir, env_bin = baked_with_development_dependencies
-    pytest_output = run([f'{env_bin}pytest'], project_dir)
+    project_dir, bin_dir = baked_with_development_dependencies
+    pytest_output = run([f'{bin_dir}pytest'], project_dir)
     assert pytest_output.returncode == 0
     assert '== 4 passed in' in pytest_output.stdout
     assert (project_dir / 'coverage.xml').exists()
     assert (project_dir / 'htmlcov/index.html').exists()
 
 
 def test_subpackage(baked_with_development_dependencies):
-    project_dir, env_bin = baked_with_development_dependencies
+    project_dir, bin_dir = baked_with_development_dependencies
     subpackage = (project_dir / 'my_python_package' / 'mysub')
     subpackage.mkdir()
     (subpackage / '__init__.py').write_text('FOO = "bar"', encoding="utf-8")
@@ -55,7 +69,19 @@ def test_subpackage(baked_with_development_dependencies):
     subsubpackage.mkdir()
     (subsubpackage / '__init__.py').write_text('FOO = "bar"', encoding="utf-8")
 
-    build_output = run([f'{env_bin}python3', 'setup.py', 'build'], project_dir)
+    if IS_WINDOWS_CI:
+        # On Windows CI python and pip executable are in different paths
+        bin_dir = ''
+    build_output = run([f'{bin_dir}python', 'setup.py', 'build'], project_dir)
     assert build_output.returncode == 0
     assert (project_dir / 'build' / 'lib' / 'my_python_package' / 'mysub' / '__init__.py').exists()
     assert (project_dir / 'build' / 'lib' / 'my_python_package' / 'mysub' / 'mysub2' / '__init__.py').exists()
+
+
+def test_generate_api_docs(baked_with_development_dependencies):
+    project_dir, bin_dir = baked_with_development_dependencies
+
+    build_output = run([f'{bin_dir}sphinx-build', '-b', 'html', 'docs', 'docs/_build/html'], project_dir)
+    assert build_output.returncode == 0
+    assert 'build succeeded' in build_output.stdout
+    assert (project_dir / 'docs' / '_build' / 'html' / 'index.html').exists()

{{cookiecutter.project_name}}/.github/next_steps/02_citation.md

@@ -9,7 +9,7 @@ It is likely that your `CITATION.cff` currently doesn't pass validation. The err
 - [ ] Add more authors if needed
 - [ ] Update `date-released` using the YYYY-MM-DD format.
 - [ ] Update the `doi` key with the conceptDOI for your repository (see [https://help.zenodo.org](https://help.zenodo.org/) for more information on what a conceptDOI is). If your project doesn't have a DOI yet, you can use the string `10.0000/FIXME` to pass validation.
-- [ ] Update the `keywords` array with some keywords of your own that describe your project.
+- [ ] Verify that the `keywords` array accurately describes your project.
 
 Once you do all the steps above, the `cffconvert` workflow will tell you what content it expected to see in `.zenodo.json`. Copy-paste from the GitHub Action log into a new file `.zenodo.json`. Afterwards, the `cffconvert` GitHub Action should be green.