Merge branch 'main' into 593-remove-docs-from-minimum

abelsiqueira · abelsiqueira · commit b9b721f9b7bf · 2024-08-29T21:29:15.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## [Unreleased]
 
 ### Added
+
 * Keep project_setup.md for all the profiles and remove from the menu [#576](https://github.com/NLeSC/python-template/pull/576)
 * Make contributing guidelines optional [#465](https://github.com/NLeSC/python-template/pull/465)
 * Make linting optional [#568](https://github.com/NLeSC/python-template/pull/568)
@@ -16,8 +17,10 @@
 * Make citation optional [#471](https://github.com/NLeSC/python-template/pull/471)
 * Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)
 * Make local documentation optional [#593](https://github.com/NLeSC/python-template/pull/593)
+* Make local test optional [#594](https://github.com/NLeSC/python-template/pull/594)
 
 ### Changed
+
 * Update the user documentation (README.md) of the template [#575](https://github.com/NLeSC/python-template/pull/623)
 * Updated .gitignore [#622](https://github.com/NLeSC/python-template/pull/622)
 * add extra info for sub-menus [#628](https://github.com/NLeSC/python-template/pull/628)
@@ -33,6 +36,7 @@
 * CHANGELOG.md is now optional ([#462](https://github.com/NLeSC/python-template/issues/462))
 
 ### Removed
+
 * Remove the configuration of isort ([#591](https://github.com/NLeSC/python-template/pull/591)), which is no longer used since [#347](https://github.com/NLeSC/python-template/issues/347).
 
 ## [0.5.0]
@@ -150,7 +154,6 @@ Released on Apr 22, 2021
 * Drop Python 3.5 support
 * Removed unit tests doing the linting
 
-
 ## [0.2.0]
 
 Released on July 17, 2019
@@ -176,14 +179,14 @@ Released on July 17, 2019
 * Fix example tests that failed to run (#28)
 * Remove quotes from project name and project description (#27)
 * Update prospector configuration (#26)
-	- Make prospector less strict
-	- Have prospector ignore the docs directory
+ 	* Make prospector less strict
+ 	* Have prospector ignore the docs directory
 * Add `install_requires` to `setup.py` (#21)
 * Improved .gitignore (#22)
 * More detailed documentation about
-	- Project setup
-	- Setup instructions
-	- NOTICE file
+ 	* Project setup
+ 	* Setup instructions
+ 	* NOTICE file
 
 ### Removed
 
@@ -196,20 +199,19 @@ Released on July 12, 2018.
 ### Added
 
 * First version of the Python project template that follows the Netherlands eScience Center software development guide, containing:
-	- Tests,
-	- Documentation,
-	- Code style checking
-	- Editorconfig
-	- Default Travis configuration
-	- Change log
-	- Code of Conduct
-	- Contributing guidelines
-	- License
-	- Manifest.in
-	- README
-	- Requirements.txt
-	- Setup configuration
-
+ 	* Tests,
+ 	* Documentation,
+ 	* Code style checking
+ 	* Editorconfig
+ 	* Default Travis configuration
+ 	* Change log
+ 	* Code of Conduct
+ 	* Contributing guidelines
+ 	* License
+ 	* Manifest.in
+ 	* README
+ 	* Requirements.txt
+ 	* Setup configuration
 
 [Unreleased]: https://github.com/NLeSC/python-template//compare/0.5.0...HEAD
 [0.5.0]:      https://github.com/NLeSC/python-template/releases/tag/0.5.0
diff --git a/copier/questions/features_code_quality.yml b/copier/questions/features_code_quality.yml
@@ -7,13 +7,16 @@ SelectCodeQualityFeatures:
   type: yaml
   default: |-
     {% if template_profile == 'recommended' %}
-      [SelectGitHubActions_flag, AddLinting_flag, AddSonarCloud_flag, AddEditorConfig_flag]
+      [AddLocalTests_flag, SelectGitHubActions_flag, AddLinting_flag, AddSonarCloud_flag, AddEditorConfig_flag]
     {%- else -%}
       []
     {%- endif %}
   help: Select code quality features
   multiselect: true
   choices:
+    Local tests:
+      value: AddLocalTests_flag
+      # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
     GitHub Actions (selection on the next menu):
       value: SelectGitHubActions_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
@@ -53,6 +56,10 @@ SelectGitHubActions:
 
 
 # computed features
+AddLocalTests:
+  type: bool
+  default: "{{ 'AddLocalTests_flag' in SelectCodeQualityFeatures or 'AddGitHubActionBuild_flag' in SelectGitHubActions or 'AddSonarCloud_flag' in SelectCodeQualityFeatures }}"
+  when: false
 AddGitHubActionBuild:
   type: bool
   default: "{{ 'AddGitHubActionBuild_flag' in SelectGitHubActions }}"
diff --git a/copier/questions/features_community.yml b/copier/questions/features_community.yml
@@ -21,6 +21,16 @@ SelectCommunityFeatures:
       value: AddContributing_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
 
+code_of_conduct_email:
+  when: "{{ 'AddCodeConduct_flag' in SelectCommunityFeatures }}"
+  type: str
+  default: "{{ email }}"
+  help: What is the email address to report code of conduct violations?
+  validator: >-
+        {% if not (code_of_conduct_email | regex_search('([A-Za-z0-9]+[.-_])*[A-Za-z0-9]+@[A-Za-z0-9-]+(\.[A-Z|a-z]{2,})+')) %}
+        Please enter a valid email address
+        {% endif %}
+
 # computed features
 AddCodeConduct:
   type: bool
diff --git a/copier/questions/package_details.yml b/copier/questions/package_details.yml
@@ -35,14 +35,6 @@ email:
         {% if not (email | regex_search('([A-Za-z0-9]+[.-_])*[A-Za-z0-9]+@[A-Za-z0-9-]+(\.[A-Z|a-z]{2,})+')) %}
         Please enter a valid email address
         {% endif %}
-code_of_conduct_email:
-  type: str
-  default: "{{ email }}"
-  help: What is the email address to report code of conduct violations?
-  validator: >-
-        {% if not (code_of_conduct_email | regex_search('([A-Za-z0-9]+[.-_])*[A-Za-z0-9]+@[A-Za-z0-9-]+(\.[A-Z|a-z]{2,})+')) %}
-        Please enter a valid email address
-        {% endif %}
 copyright_holder:
   type: str
   default: "{{ full_name }}"
diff --git a/template/project_setup.md.jinja b/template/project_setup.md.jinja
@@ -35,6 +35,7 @@ You can distribute your code using PyPI.
 [The guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=building-and-packaging-code) can
 help you decide which tool to use for packaging.
 
+{% if AddLocalTests -%}
 ## Testing and code coverage
 
 - Tests should be put in the `tests` folder.
@@ -47,6 +48,7 @@ help you decide which tool to use for packaging.
 - The project uses [GitHub action workflows](https://docs.github.com/en/actions) to automatically run tests on GitHub infrastructure against multiple Python versions
   - Workflows can be found in [`.github/workflows`](.github/workflows/)
 - [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=testing)
+{%- endif %}
 
 {% if AddLocalDocumentation -%}
 ## Documentation
diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -45,9 +45,11 @@ version = "{{ version }}"
 dev = [
     "build",  # build is not only used in publishing (below), but also in the template's test suite
     "bump-my-version",
+    {%- if AddLocalTests %}
     "coverage [toml]",
     "pytest",
     "pytest-cov",
+    {%- endif %}
     "ruff",
     "sphinx",
     "sphinx_rtd_theme",
@@ -78,22 +80,28 @@ Changelog = "{{ repository_url }}/CHANGELOG.md"
 {% if AddOnlineDocumentation -%}
 ReadTheDocs = "https://{{ package_name }}.readthedocs.io"
 {% endif %}
+{% if AddLocalTests -%}
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+{% endif %}
 
+{% if AddLocalTests -%}
 [tool.coverage.run]
 branch = true
 source = ["src/{{ package_name }}"]
 command_line = "-m pytest"
+{%- endif %}
 
 [tool.tox]
 legacy_tox_ini = """
 [tox]
 envlist = py38,py39,py310,py311,py312
 skip_missing_interpreters = true
+{% if AddLocalTests -%}
 [testenv]
 commands = pytest
 extras = dev
+{%- endif %}
 """
 
 [tool.ruff]
diff --git a/template/src/{{package_name}}/my_module.py.jinja b/template/src/{{package_name}}/my_module.py.jinja
@@ -24,7 +24,7 @@ def hello(name: str) -> str:
         'Hello Jane Smith!'
 
     """
-    if name == 'nobody':
-        msg = 'Can not say hello to nobody'
+    if name == "nobody":
+        msg = "Can not say hello to nobody"
         raise ValueError(msg)
-    return f'Hello {name}!'
+    return f"Hello {name}!"
diff --git a/template/{% if AddContributing %}CONTRIBUTING.md{% endif %}.jinja b/template/{% if AddContributing %}CONTRIBUTING.md{% endif %}.jinja
@@ -34,8 +34,10 @@ The sections below outline the steps in each case.
 {% if AddDevDoc -%}
 1. install dependencies (see the [development documentation](README.dev.md#development_install));
 {%- endif %}
+{% if AddLocalTests -%}
 1. make sure the existing tests still work by running ``pytest``;
 1. add your own tests (if necessary);
+{%- endif %}
 1. update or expand the documentation;
 {% if AddChangeLog -%}
 1. update the `CHANGELOG.md` file with your change;
diff --git a/template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja b/template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja
@@ -70,10 +70,10 @@ activated virtual environment with the development tools installed.
 
 ```shell
 # linter
-ruff .
+ruff check .
 
 # linter with automatic fixing
-ruff . --fix
+ruff check . --fix
 ```
 
 To fix readability of your code style you can use [yapf](https://github.com/google/yapf).
diff --git a/template/{% if AddLocalTests %}tests{% endif %}/__init__.py b/template/{% if AddLocalTests %}tests{% endif %}/__init__.py
diff --git a/template/{% if AddLocalTests %}tests{% endif %}/test_my_module.py.jinja b/template/{% if AddLocalTests %}tests{% endif %}/test_my_module.py.jinja
@@ -5,22 +5,22 @@ from {{ package_name }}.my_module import hello
 
 def test_hello():
     """Example using assert."""
-    assert hello('nlesc') == 'Hello nlesc!'
+    assert hello("nlesc") == "Hello nlesc!"
 
 
 def test_hello_with_error():
     """Example of testing for raised errors."""
     with pytest.raises(ValueError) as excinfo:
-        hello('nobody')
-    assert 'Can not say hello to nobody' in str(excinfo.value)
+        hello("nobody")
+    assert "Can not say hello to nobody" in str(excinfo.value)
 
 
 @pytest.fixture
 def some_name():
     """Example fixture."""
-    return 'Jane Smith'
+    return "Jane Smith"
 
 
 def test_hello_with_fixture(some_name: str):
     """Example using a fixture."""
-    assert hello(some_name) == 'Hello Jane Smith!'
+    assert hello(some_name) == "Hello Jane Smith!"
diff --git a/tests/test_project.py b/tests/test_project.py
@@ -191,7 +191,7 @@ def test_ruff_check(baked_with_development_dependencies, project_env_bin_dir):
     project_dir = baked_with_development_dependencies
     bin_dir = project_env_bin_dir
 
-    result = run([f'{bin_dir}ruff', 'check', '--fix'], project_dir)
+    result = run([f'{bin_dir}ruff', 'check'], project_dir)
     assert result.returncode == 0
     assert '' in result.stdout
 
