mirror of
https://github.com/fhswf/aki_prj23_transparenzregister.git
synced 2025-04-24 21:32:33 +02:00
Philipp Horstenkamp
fea31e543b
Fixed the following errors: - Typo in readme.md - Mongo delivers the last_update of an company as a string not as date. Added: - Entrypoint description in readme.md
65 lines
2.5 KiB
Markdown
65 lines
2.5 KiB
Markdown
# aki_prj23_transparenzregister
|
|
|
|
[](https://www.python.org)
|
|
[](https://github.com/astral-sh/ruff/actions)
|
|
[](https://github.com/astral-sh/ruff)
|
|
[](https://github.com/pre-commit/pre-commit)
|
|
[](http://mypy-lang.org/)
|
|
[](https://mypy.readthedocs.io/en/stable/?badge=stable)
|
|
[](https://github.com/psf/black)
|
|
|
|
## Contributions
|
|
|
|
See the [CONTRIBUTING.md](CONTRIBUTING.md) about how code should be formatted and what kind of rules we set ourselves.
|
|
|
|
## Available entrypoints
|
|
|
|
The project has currently the following entrypoint available:
|
|
|
|
- data-transfer > Transfers all the data from the mongodb into the sql db to make it available as production data.
|
|
- reset-sql > Resets all sql tables in the connected db.
|
|
|
|
## DB Connection settings
|
|
|
|
To connect to the SQL db see [sql/connector.py](./src/aki_prj23_transparenzregister/utils/sql/connector.py)
|
|
To connect to the Mongo db see [connect]
|
|
|
|
Create a `secrets.json` in the root of this repo with the following structure (values to be replaces by desired config):
|
|
|
|
```json
|
|
{
|
|
"postgres": {
|
|
"username": "postgres",
|
|
"password": "postgres",
|
|
"host": "localhost",
|
|
"database": "postgres",
|
|
"port": 5432
|
|
},
|
|
"mongo": {
|
|
"username": "username",
|
|
"password": "password",
|
|
"host": "localhost",
|
|
"database": "transparenzregister",
|
|
"port": 27017
|
|
}
|
|
}
|
|
```
|
|
|
|
Alternatively, the secrets can be provided as environment variables. One option to do so is to add a `.env` file with
|
|
the following layout:
|
|
|
|
```
|
|
PYTHON_POSTGRES_USERNAME=postgres
|
|
PYTHON_POSTGRES_PASSWORD=postgres
|
|
PYTHON_POSTGRES_HOST=localhost
|
|
PYTHON_POSTGRES_DATABASE=postgres
|
|
PYTHON_POSTGRES_PORT=5432
|
|
PYTHON_MONGO_USERNAME=username
|
|
PYTHON_MONGO_HOST=localhost
|
|
PYTHON_MONGO_PASSWORD=password
|
|
PYTHON_MONGO_PORT=27017
|
|
PYTHON_MONGO_DATABASE=transparenzregister
|
|
```
|
|
|
|
The prefix `PYTHON_` can be customized by setting a different `prefix` when constructing the ConfigProvider.
|