Merge pull request #1 from tifa365/main

initial commit

README.md

@@ -1,42 +1,5 @@
 [[DE]](README.md)/[[EN]](README_en.md)
 
+# Bundes-Klinik-Atlas API
 
-# [_TEMPLATE_]
-
-## Quickstart
-
-- Add openAPI spec in German to _openapi.yml_
-- Add openAPI spec in English to _openapi_en.yml_ (or remove _openapi_en.yml_ )
-- Update _index.html_ (insert the API-name in the title)
-- Update _generator_config.yaml_ (Update all values surrounded with <>)
-- Update the url in _CNAME_ once the api has its own subdomain
-- Replace the content of README.md with a German description of the API
-- Fill (or remove) README_en.md or add README-files in other languages.
-
-
-## Add Library to deutschland package
-
-Fork the [deutschland](https://github.com/bundesAPI/deutschland) package:
-
-1. In the `pyproject.toml` of the [deutschland-package](https://github.com/bundesAPI/deutschland/blob/main/pyproject.toml) add a entry in the dependency section. The values for `<NAME>` and `<VERSION>` must match with the values in `generator_config.yaml`
-   For Example: 
-
-   ```de-`<NAME>`  = {version= "^`<VERSION>`", optional = true}```
-2. Under the ```[tool.poetry.extras]``` section add the following
-   ```<NAME>`  =["de-`<NAME>`"]```
-
-   Also add de-name in the all list:
-```
-    all = ["de-bundestag-lobbyregister","de-dip-bundestag","de-pegel-online","de-ausbildungssuche",
-    "de-berufssprachkurssuche","de-coachingangebote","de-dip-bundestag","de-entgeltatlas",
-    "de-hochwasserzentralen","de-pflanzenschutzmittelzulassung","de-studiensuche",
-    "de-tagesschau", "de-weiterbildungssuche","de-feiertage",...,"de-`<NAME>`"]
-```
-
-3. Add apis into [test_imports.py](https://github.com/bundesAPI/deutschland/blob/main/tests/test_imports.py)
-    ```
-    from deutschland.<NAME>.apis import DefaultApi
-   ```
-
-4. Open a [merge request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
-
+Die Bundes-Klinik-Atlas API steht hinter der Seite https://bundes-klinik-atlas.de/ und stellt umfassende und vergleichbare Informationen über deutsche Kliniken bereit. Die Daten unterstützen Patient:innen bei der Auswahl des richtigen Krankenhauses und bieten umfassende Informationen über die Versorgungsqualität, die ärztliche und pflegerische Personalausstattung sowie andere wichtige Datenpunkte.

README_en.md

@@ -1,14 +1,5 @@
 [[DE]](README.md)/[[EN]](README_en.md)
 
+# Bundes-Klinik-Atlas API
 
-# [_TEMPLATE_]
-
-## Quickstart
-
-- Add openAPI spec in German to _openapi.yml_
-- Add openAPI spec in English to _openapi_en.yml_ (or remove _openapi_en.yml_ )
-- Update _index.html_ (insert the API-name in the title)
-- Update _generator_config.yaml_ (Update all values surrounded with <>)
-- Update the url in _CNAME_ once the api has its own subdomain
-- Replace the content of README.md with a German description of the API
-- Fill (or remove) README_en.md or add README-files in other languages.
+The Bundes-Klinik-Atlas API powers the website https://bundes-klinik-atlas.de/ and provides comprehensive and comparable information about German clinics. The data supports patients in choosing the right hospital and offers detailed information about the quality of care, the medical and nursing staff, and other important data points.

generator_config.yaml

@@ -1,15 +1,15 @@
-templateDir: deutschland_templates # For local use: ./local/deutschland_templates
+templateDir: deutschland_templates
 additionalProperties:
-  packageName: "<NAME>"
+  packageName: "klinikatlas"
   infoName: "BundesAPI"
   infoEmail: "[email protected]"
-  packageVersion: <VERSION>
-  packageUrl: "https://github.com/bundesAPI/<REPO>"
+  packageVersion: "1.0.0"
+  packageUrl: "https://github.com/bundesAPI/klinikatlas-api"
   namespace: "deutschland"
   docLanguage: "de"
 gitHost: "github.com"
 gitUserId: "bundesAPI"
-gitRepoId: "<REPO-ID>"
+gitRepoId: "klinikatlas-api"
 files:
   pyproject.mustache:
     destinationFilename: pyproject.toml

index.html

@@ -4,7 +4,7 @@
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <link rel="stylesheet" type="text/css" href="//cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.51.1/swagger-ui.min.css">
-    <title>{{repo_name}} - OpenAPI Documentation</title>
+    <title>Bundes-Klinik-Atlas API - OpenAPI Documentation</title>
 
 <body>
     <div><small><a href="index.html">[DE]</a><a id="en" href="#">/[EN]</a></small></div>