Skip to content

Commit

Permalink
#219: Updated project template configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
ckunki committed Jul 15, 2024
1 parent bf64028 commit 755d011
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 5 deletions.
4 changes: 4 additions & 0 deletions doc/changes/changes_0.14.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@
## 🔩 Internal

* Relock dependencies

## Refactorings

* #219: Updated project template configuration
11 changes: 8 additions & 3 deletions doc/user_guide/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down Expand Up @@ -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
+++++++++++++++++++++++++++++
Expand Down
2 changes: 1 addition & 1 deletion project-template/cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"description": "",
"autor_full_name": "",
"autor_email": "",
"error_tags": "",
"project_short_tag": "",
"license_year": "{% now 'utc', '%Y' %}",
"__repo_name_slug": "{{cookiecutter.package_name}}",
"__package_name_slug": "{{cookiecutter.package_name}}",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
error-tags:
{{cookiecutter.error_tags}}:
{{cookiecutter.project_short_tag}}:
highest-index: 0

0 comments on commit 755d011

Please sign in to comment.