32 lines
1.2 KiB
Markdown
32 lines
1.2 KiB
Markdown
# piano_repertoire
|
||
|
||
The piano_repertoire-project develops a database to keep track of the pieces a pianist can play, as well as an app to interact with the database. The software is open source and developed under the MIT license.
|
||
|
||
## Features
|
||
|
||
At the moment, an alpha version is undertaken, with these features:
|
||
|
||
### Database
|
||
|
||
- The sqlite-database holds a growing number of piano-solo pieces, together with their exact catalogue-numbers and composers.
|
||
- Prepared in this database is a table for users (pianists), that marks which of the pieces can be played.
|
||
|
||
### Application and usage
|
||
|
||
- Create new users (`n username`)
|
||
- Show users (`su`)
|
||
- Set an active user (`a number_of_user`)
|
||
- Show the pieces stored in the database (`s`)
|
||
- Mark pieces as mastered for the active user (`m number_of_work`)
|
||
- Show pieces by composer (`sc` shows composers, `c number_of_composer` shows pieces)
|
||
- (planned) Show movements through pieces
|
||
|
||
## Requirements
|
||
|
||
- Python 3.9 or higher
|
||
- Enough disk space to hold the database
|
||
- run `python builddb.py` to build the SQLite-database-file before running `python rep_cli.py`
|
||
|
||
## Known Bugs
|
||
|
||
- Marking a piece as mastered the second time, the database won’t insert the entry and the program will crash |