@@ -5,25 +5,19 @@ Getting Started
55
66Your usage of the `exasol-toolbox ` will likely fall into one of two scenarios:
77
8- #. Integration into an existing project.
9-
10- If this is your situation, proceed to the section titled :ref: `Integrating Exasol-Toolbox into your Project <existing >`.
11-
12- #. Creation of a new project.
13-
14- If you are starting a new project, please read the section :ref: `Create a New Project with Exasol-Toolbox Support <new project >`.
8+ #. :ref: `existing `
9+ #. :ref: `new project `
1510
1611.. _new project :
1712
18- Create a New Project with Exasol-Toolbox Support
19- -------------------------------------------------
13+ Creating a New Project with Exasol-Toolbox Support
14+ --------------------------------------------------
2015
2116.. important ::
2217
23- To establish a new project with toolbox support, you need to have `Cookiecutter <https://www.cookiecutter.io >`_ installed.
18+ To establish a new project with toolbox support, you need to have `Cookiecutter <https://www.cookiecutter.io >`_ installed:
2419
25- **TL;DR: **
26- :code: `pipx install cookiecutter `
20+ :code: `pip install cookiecutter `
2721
2822
2923**1. Create a new project **
@@ -59,7 +53,8 @@ Generate a poetry environment for the project:
5953
6054.. code-block :: shell
6155
62- poetry shell
56+ # An example python_version value is python3.10
57+ poetry env use < python_version>
6358
6459 Install all necessary project and development dependencies for the project:
6560
@@ -81,8 +76,8 @@ List all available nox sessions:
8176Integrating Exasol-Toolbox into your Project
8277--------------------------------------------
8378
84- 1. Add the toolbox as dependency
85- ++++++++++++++++++++++++++++++++
79+ 1. Add the toolbox as a dependency
80+ ++++++++++++++++++++++++++++++++++
8681
8782.. code-block :: shell
8883
@@ -98,21 +93,23 @@ example shown below.
9893
9994 For further details on plugins, see the customization section.
10095
101- .. literalinclude :: ../../project-template/{{cookiecutter.repo_name}}/noxconfig.py
102- :language: python3
96+ .. collapse :: noxconfig.py
97+
98+ .. literalinclude :: ../../project-template/{{cookiecutter.repo_name}}/noxconfig.py
99+ :language: python3
103100
1041013. Configure the tooling
105102++++++++++++++++++++++++
106103Configuration values for the tooling should be defined in the ``pyproject.toml ``.
107104Copy the example below & adapt it for your project's specific needs.
108105
109- .. literalinclude :: ../../project-template/{{cookiecutter.repo_name}}/pyproject.toml
110- :language: toml
111- :start-after: # Tooling
106+ .. collapse :: pyproject.toml (tool specific configuration)
112107
113- For further reference, see the specific configurations for:
108+ .. literalinclude :: ../../project-template/{{cookiecutter.repo_name}}/pyproject.toml
109+ :language: toml
110+ :start-after: # Tooling
114111
115- * :ref: `formatting code <formatting_configuration >`
112+ For further reference, see the :ref: `formatting code configuration <formatting_configuration >` section.
116113
117114
1181154. Make the toolbox sessions available
@@ -121,26 +118,22 @@ To use the standard toolbox session via nox, just import them in your ``noxfile.
121118If you only need the standard sessions provided by the toolbox, your ``noxfile.py `` is
122119straightforward, and you just can use the example ``noxfile.py `` below.
123120
124- .. literalinclude :: ../../project-template/{{cookiecutter.repo_name}}/noxfile.py
125- :language: python3
126-
127-
128- .. attention ::
121+ .. collapse :: noxfile.py
129122
130- Keep in mind that the current path may not be included in the :code: `PYTHONPATH `, depending on the operating system you are using. This is explained in more detail in this resource: https://fedoraproject.org/wiki/Changes/PythonSafePath. Thus, it might be necessary to properly set the :code: `PYTHONPATH ` before running nox. This is because our nox sessions expect the `noxconfig ` module to be located within the python path.
123+ .. literalinclude :: ../../project-template/{{cookiecutter.repo_name}}/noxfile.py
124+ :language: python3
131125
132- For additional information on resolving this issue, please :ref: `refer to <faq_no_module_noxconfig >`.
133126
1341275. Set up the GitHub ``pre-commit `` hooks [optional]
135128++++++++++++++++++++++++++++++++++++++++++++++++++++
136129
137- See :ref: `pre-commit_configuration ` for the required steps.
130+ See the :ref: `pre-commit configuration < pre- commit_configuration>` section for the required steps.
138131
139132
1401336. Set up deploying documentation (optional)
141134++++++++++++++++++++++++++++++++++++++++++++
142135
143- See :ref: `documentation_configuration ` for the required steps.
136+ See the :ref: `documentation configuration < documentation_configuration >` section for the required steps.
144137
1451387. Set up Sonar
146139+++++++++++++++
0 commit comments