Skip to content

Commit

Permalink
adapt static files list
Browse files Browse the repository at this point in the history
and add documentation for pyproject generation.
  • Loading branch information
KerstenBreuer committed Dec 20, 2023
1 parent c264da5 commit b0ac4cb
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 6 deletions.
29 changes: 29 additions & 0 deletions .pyproject_generation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--
Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
for the German Human Genome-Phenome Archive (GHGA)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# Generating the pyproject.toml

The pyproject.toml of the service is generated by combining static configuration
captured in [`./pyproject_template.toml`](./pyproject_template.toml) and custom
package metadata specified in [`./pyproject_custom.toml`](./pyproject_custom.toml).

The `./pyproject_template.toml` is managed by the template, please do not edit manually.

You may specify properties in the `./pyproject_custom.toml` which are already specified
in the `./pyproject_template.toml`. In that case, the `./pyproject_custom.toml` takes
priority.
8 changes: 2 additions & 6 deletions .template/static_files.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ scripts/README.md
.github/workflows/check_config_docs.yaml
.github/workflows/check_openapi_spec.yaml
.github/workflows/check_readme.yaml
./github/workflows/check_pyproject.yaml
.github/workflows/check_pyproject.yaml
.github/workflows/check_template_files.yaml
.github/workflows/ci_release.yaml
.github/workflows/ci_workflow_dispatch.yaml
Expand All @@ -44,7 +44,7 @@ example_data/README.md

.template/README.md

.readme_generation/.readme_template.md
.readme_generation/readme_template.md
.readme_generation/README.md

.pyproject_generation/pyproject_template.toml
Expand All @@ -53,11 +53,7 @@ example_data/README.md
lock/requirements-dev-template.in
lock/README.md

.coveragerc
.gitattributes
.gitignore
.mypy.ini
.ruff.toml
pytest.ini

LICENSE

0 comments on commit b0ac4cb

Please sign in to comment.