add hint in quickstart to look at dac-example-energy for a usage example

Author: francesco086

.pre-commit-config.yaml

@@ -12,19 +12,26 @@ repos:
       - id: check-json
       - id: check-toml
       - id: check-yaml
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
-    hooks:
-      - id: mypy
-        exclude: test/data/schema/wrong_syntax.py
-  - repo: https://github.com/dosisod/refurb
-    rev: v2.0.0
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.22
     hooks:
-      - id: refurb
-        exclude: test/data/schema/wrong_syntax.py
+      - id: mdformat
+        args: ["--wrap", "120"]
+        additional_dependencies:
+          - mdformat-tables
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.11.4
     hooks:
     - id: ruff
       args: [--fix, --exit-non-zero-on-fix]
       exclude: test/data/schema/wrong_syntax.py
+  - repo: https://github.com/dosisod/refurb
+    rev: v2.0.0
+    hooks:
+      - id: refurb
+        exclude: test/data/schema/wrong_syntax.py
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        exclude: test/data/schema/wrong_syntax.py

CHANGELOG.md

@@ -2,77 +2,84 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 **IMPORTANT**: Currently the project is in the initial development phase, this is why releases are marked as `0.z.y`.
 (following [semantic versioning 2.0.0](https://semver.org/): "Major version zero (0.y.z) is for initial development.
-Anything MAY change at any time. The public API SHOULD NOT be considered stable.").
-While in this phase, we will denote breaking changes with a minor increase.
+Anything MAY change at any time. The public API SHOULD NOT be considered stable."). While in this phase, we will denote
+breaking changes with a minor increase.
 
 ## 0.4.3
 
 ### Added
 
-* Added support for python `3.12` and `3.13`
+- Added support for python `3.12` and `3.13`
 
 ### Changed
 
-* Bump all dependencies to the latest version and introduce necessary adaptation in the source code (affecting only `dac info`):
-  * `build~=0.9`      -> `build~=1.2`
-  * `toml~=0.10`      -> `toml~=0.10.2`
-  * `typer[all]~=0.7` -> `typer~=0.15.2`
-  * `wheel~=0.38`     -> `wheel~=0.45`
-* Prevent installation with python > `3.13`
+- Bump all dependencies to the latest version and introduce necessary adaptation in the source code (affecting only
+  `dac info`):
+  - `build~=0.9` -> `build~=1.2`
+  - `toml~=0.10` -> `toml~=0.10.2`
+  - `typer[all]~=0.7` -> `typer~=0.15.2`
+  - `wheel~=0.38` -> `wheel~=0.45`
+- Prevent installation with python > `3.13`
 
 ## 0.4.2
 
 ### Fixed
 
-* `dac next-version` is able to find the existing version of a package irrespectively of the use of `-` or `_` as a separator.
+- `dac next-version` is able to find the existing version of a package irrespectively of the use of `-` or `_` as a
+  separator.
 
 ## 0.4.1
 
 ### Added
 
-* Introduce `dac next-version` command, that allows to find the next minor release for a given python package and (optionally) a given major version.
+- Introduce `dac next-version` command, that allows to find the next minor release for a given python package and
+  (optionally) a given major version.
 
 ## 0.4.0
 
 ### Changed
 
-* The `load` function in `load.py` can contain optional arguments. Previously no arguments were allowed.
-* `load.py` and `schema.py` are publicly accessible under `dac_pkg_name.load` and `dac_pkg_name.schema` respectively. Previously they were marked as private modules, under `dac_pkg_name._load` and `dac_pkg_name._schema`.
-* `Schema` does not have to be a `pandera.DataFrameModel` anymore, but any class that implements a `validate` method (see the `_input.interface.Validator` protocol).
-* `dac` does not rely on [`pydantic`](https://pypi.org/project/pydantic/) anymore, and uses [`dataclass`](https://docs.python.org/3/library/dataclasses.html#) instead.
-  Changes affect `PackConfig` and `PyProjectConfig`.
+- The `load` function in `load.py` can contain optional arguments. Previously no arguments were allowed.
+- `load.py` and `schema.py` are publicly accessible under `dac_pkg_name.load` and `dac_pkg_name.schema` respectively.
+  Previously they were marked as private modules, under `dac_pkg_name._load` and `dac_pkg_name._schema`.
+- `Schema` does not have to be a `pandera.DataFrameModel` anymore, but any class that implements a `validate` method
+  (see the `_input.interface.Validator` protocol).
+- `dac` does not rely on [`pydantic`](https://pypi.org/project/pydantic/) anymore, and uses
+  [`dataclass`](https://docs.python.org/3/library/dataclasses.html#) instead. Changes affect `PackConfig` and
+  `PyProjectConfig`.
 
 ## 0.3.3
 
 ### Fixed
 
-* Cleanup
+- Cleanup
 
 ## 0.3.2
 
 ### Changed
 
-* Extend compatibility to pydantic v1. Now `dac` works with both v1 and v2 of pydantic
+- Extend compatibility to pydantic v1. Now `dac` works with both v1 and v2 of pydantic
 
 ## 0.3.1
 
 ### Changed
 
-* Update code to be compatible with pydantic v2 (no retro-compatibility with v1)
+- Update code to be compatible with pydantic v2 (no retro-compatibility with v1)
 
 ## 0.3.0
 
 ### Changed
 
-* Dependencies passed in CLI `--pkg-dependencies` or `PyProjectConfig` must be separated by `;` or newline (previously was `,` or newline)
+- Dependencies passed in CLI `--pkg-dependencies` or `PyProjectConfig` must be separated by `;` or newline (previously
+  was `,` or newline)
 
 ## 0.2.0
 
 ### Added
 
-* First release of `dac`
+- First release of `dac`

README.md

@@ -6,8 +6,8 @@
 
 **IMPORTANT**: Currently the project is in the initial development phase, this is why releases are marked as `0.z.y`.
 (following [semantic versioning 2.0.0](https://semver.org/): "Major version zero (0.y.z) is for initial development.
-Anything MAY change at any time. The public API SHOULD NOT be considered stable.").
-While in this phase, we will denote breaking changes with a minor increase.
+Anything MAY change at any time. The public API SHOULD NOT be considered stable."). While in this phase, we will denote
+breaking changes with a minor increase.
 
 ## Quickstart
 
@@ -18,33 +18,37 @@ python -m pip install dac
 ```
 
 Then use the integrated help to find out its functionalities
+
 ```sh
 dac --help
 ```
 
+If you want to see a usage example, you can have a look at how `dac` is used to build the `dac-example-energy` DaC
+python package [here](https://gitlab.com/data-as-code/energy-dac-example) (look at `.gitlab-ci.yml`).
+
 ## Setup development environment (for contributors only)
 
-* Create a virtual environment and activate it
+- Create a virtual environment and activate it
 
   ```shell
   python -m venv venv
   . venv/bin/activate
   ```
 
-* Install the developer dependencies
+- Install the developer dependencies
 
   ```shell
   python -m pip install -U pip wheel setuptools
   python -m pip install -r requirements-dev.txt
   ```
 
-* Enable the pre-commits
+- Enable the pre-commits
 
   ```shell
   pre-commit install
   ```
 
-* To run all the tests
+- To run all the tests
 
   ```shell
   pytest --run-slow