#219 update project template configuration (#220)

* #219: Updated project template configuration
* Updated install instruction in README
* Updated file .gitignore
* Use double quotes in file pyproject.toml
* Create directory for workflows before installing templates
* Added python_version_min and pypi_package_name

Author: ckunki

.gitignore

@@ -53,3 +53,6 @@ nosetests.xml
 .project
 .pydevproject
 .vscode/settings.json
+
+# Emacs
+TAGS

doc/changes/unreleased.md

@@ -6,3 +6,7 @@
 ## 🔩 Internal
 * Update depdency constraints
 * Relock dependencies
+
+## Refactorings
+
+* #219: Updated project template configuration

doc/github_actions/security_issues.rst

@@ -26,7 +26,7 @@ Example Usage
 
         steps:
           - name: SCM Checkout
-            uses: actions/checkout@v4
+            uses: actions/checkout@v3
 
           - name: Report Security Issues
             uses: exasol/python-toolbox/.github/actions/[email protected]

doc/user_guide/getting_started.rst

@@ -20,17 +20,22 @@ Create a New Project with Exasol-Toolbox Support
 
     To establish a new project with toolbox support, you need to have `Cookiecutter <https://www.cookiecutter.io>`_ installed.
 
-    **TL;DR:** 
+    **TL;DR:**
         :code:`pipx install cookiecutter`
 
 
 **1. Create a new project**
 
+Cookiecutter will create the project within the current directory. So if you
+usually checkout all your GitHub repos in ``~/git`` you could use ``cd ~/git``
+before calling cookiecutter.
+
 Use the following command to create a new project:
 
 .. code-block:: shell
 
-   cookiecutter https://github.com/exasol/python-toolbox.git --directory project-template
+   cookiecutter https://github.com/exasol/python-toolbox.git \
+     --directory project-template
 
 **2. Follow the interactive project setup prompt**
 
@@ -154,7 +159,7 @@ forward and you just can use the example *noxfile.py* bellow.
 
     For additional information on resolving this issue, please :ref:`refer to <faq_no_module_noxconfig>`.
 
-        
+
 
 6. Setup the pre-commit hooks
 +++++++++++++++++++++++++++++

exasol/toolbox/tools/workflow.py

@@ -56,6 +56,7 @@ def install_workflow(
 
     Attention: If there is an existing workflow with the same name it will be overwritten!
     """
+    dest.mkdir(parents=True)
     template.install_template(
         template=workflow, dest=dest, pkg=PKG, template_type=TEMPLATE_TYPE
     )

project-template/cookiecutter.json

@@ -2,10 +2,12 @@
   "project_name": "Yet Another Project",
   "repo_name": "{{cookiecutter.project_name | lower | replace(' ', '-')}}",
   "package_name": "{{cookiecutter.repo_name | replace('-', '_')}}",
+  "pypi_package_name": "exasol-{{cookiecutter.repo_name}}",
   "description": "",
   "autor_full_name": "",
   "autor_email": "",
-  "error_tags": "",
+  "project_short_tag": "",
+  "python_version_min": "3.9",
   "license_year": "{% now 'utc', '%Y' %}",
   "__repo_name_slug": "{{cookiecutter.package_name}}",
   "__package_name_slug": "{{cookiecutter.package_name}}",

project-template/{{cookiecutter.repo_name}}/.gitignore

@@ -140,3 +140,6 @@ doc/api
 .build_output
 .html-documentation
 itde/
+
+# Emacs
+TAGS

project-template/{{cookiecutter.repo_name}}/README.md

@@ -29,7 +29,7 @@
 ## 💾 Installation
 
 ```shell
-pip install {{cookiecutter.package_name}}
+pip install {{cookiecutter.pypipackage_name}}
 ```
 
 ## 📚 Documentation

project-template/{{cookiecutter.repo_name}}/error_code_config.yml

@@ -1,3 +1,3 @@
 error-tags:
-  {{cookiecutter.error_tags}}:
+  {{cookiecutter.project_short_tag}}:
     highest-index: 0

project-template/{{cookiecutter.repo_name}}/pyproject.toml

@@ -5,7 +5,7 @@ requires = [
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-name = "exasol-{{cookiecutter.repo_name}}"
+name = "{{cookiecutter.pypi_package_name}}"
 packages  = [
     {include = "exasol"},
 ]
@@ -18,15 +18,15 @@ authors = [
     "{{cookiecutter.autor_full_name}} <{{cookiecutter.autor_email}}>"
 ]
 
-readme = 'README.md'
+readme = "README.md"
 
 repository = "https://github.com/exasol/{{cookiecutter.repo_name}}"
 homepage = "https://github.com/exasol/{{cookiecutter.repo_name}}"
 
 keywords = ['exasol', '{{cookiecutter.package_name}}']
 
 [tool.poetry.dependencies]
-python = ">=3.9,<4.0"
+python = ">={{python_version_min}},<4.0"
 
 [tool.poetry.group.dev.dependencies]
 exasol-toolbox = ">=0.12.0"