tobias/the_works
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added info about dependencies; expanded section with flask commands; added section about helpful tools for the project

Browse Source
This commit is contained in:
eclipse 2025-07-15 23:16:23 +02:00
parent be4e834f56
commit 1d0a60f283
1 changed files with 51 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -7,4 +7,54 @@ Execute commands with `python -m flask --app the_works <command>`
Available commands:
* `run`: Serve app (don't use for production).
* `init-db`: Create empty SQLite database `works.sqlite` in project root. BE CAREFUL: If a database already exists, it will be deleted with everything in it.
<!--* `init-db`: Create empty SQLite database `works.sqlite` in project root. BE CAREFUL: If a database already exists, it will be deleted with everything in it. // 5/25: ich hab die Fkt. wieder rausgenommen, aber ich könnte sie eigentlich prima wieder einbauen … -->
* `shell`: start a shell within the app context (I can i.e. import specific table models and test the data structures returned by ORM methods like select())
*
## Dependencies
### Python Packages
flask
flask-sqlalchemy
python-dotenv
Pillow
pytest
flask-debugtoolbar (optional)
### CSS and Javascript
PicoCSS (regular version) + SwitchColorMode.js (from Yohn's fork)
DataTables.[js|css]
### Icons
some icons from heroicons.com
## Other useful stuff
### Export database schema
Method 1: `sqlite3 the_works.sqlite .schema > outputfile.sql`
Method 2: Open DB in SQLitebrowser and use File -> Export -> Database to SQL file …
* keep original CREATE statements
* export schema only
* overwrite old schema (DROP TABLE, then CREATE TABLE)
### Generate declarative SQLAlchemy code
Right now the_works reflects an existing database in order to infer the underlying data models for SQLAlchemy. If I wanted to declare the data models directly instead of using reflection, I would need declarative code. This code can be generated from an existing database with the help of [sqlacodegen](https://pypi.org/project/sqlacodegen/):
`sqlacodegen sqlite:///path/to/db.sqlite > outputfile.py`
### Generate `requirements.txt`
I use [pipreqs](https://pypi.org/project/pipreqs/) to generate the file `requirements.txt`. The package scans all source files for import statements and uses those to extract all required Pip packages.