UPiano
A Piano in your terminal.
Screenshot
How to run
First, you'll need to install FluidSynth, if you haven't already. See here how to install FluidSynth on your system.
Then, install upiano via pip:
pip install upiano
And then run:
upiano
Make sure your terminal window is big enough. The wider you can make it, the more keys you'll have! 🎹 😀
How to play
To play with the mouse, click on the notes you want to play.
To play with the computer keyboard, there is a limited and currently hardcoded keymap that corresponds to the following, which will play the notes on the left side:
┌─┬──┬┬──┬─┬─┬──┬┬──┬┬──┬─┬─┬──┬┬──┬─┬─┬──┬┐
│ │██││██│ │ │██││██││██│ │ │██││██│ │ │██││
│ │W█││E█│ │ │T█││Y█││U█│ │ │O█││P█│ │ │██││
│ └┬─┘└┬─┘ │ └┬─┘└┬─┘└┬─┘ │ └┬─┘└┬─┘ │ └┬─┘│
│A │ S │ D │F │ G │ H│ J │K │ L │ ; │' │ │
└──┴───┴───┴──┴───┴───┴───┴──┴───┴───┴──┴──┘
Note that since the terminal doesn't really support key press and release events (it receives a stream of characters instead), there is no way to support two key playing at the same time with the computer keyboard only.
But you can play with the computer keyboard and with the mouse simultaneously, as you can see in this video: https://www.youtube.com/watch?v=0VXit110PcA
Powered by
Made with ❤️ by Elias Dorneles
History
This started as a fun pairing project by friends Elias and Nandaja around 2017, after they had finished their Recurse Center retreat and were missing hacking together.
They had fun building a small terminal piano app using
urwid for the user interface and playing notes by spawning
sox subprocesses. This version is available in
the project source code, if you have urwid and sox installed, you can try it by
running: python upiano/legacy.py.
Fast-forward to 2023, Elias attended EuroPython and learned the Textual library there, got excited about terminal apps again and decided to reboot this project using the newly acquired knowledge, package and distribute it, and add to the fun by plugging a true synthesizer to it, and playing with its controls.
Changelog:
- v0.1.2
- added volume, reverb and chorus sliders
- fix packaging config, to work on any Python 3.10+
- v0.1.1
- added sustain
- fix mouse handling, and allow playing by "swiping" over keys
- v0.1.0
- first version released to PyPI, already using Textual
Metadata
Release files for upiano 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| upiano-0.1.2.tar.gz | 28.3 MB | Without provenance | Details for upiano-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| upiano-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for upiano-0.1.2-py3-none-any.whl |
Total release size: 56.6 MB
Release files / upiano-0.1.2.tar.gz
| Download URL | upiano-0.1.2.tar.gz |
|---|---|
| Size | 28.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9bc51582e5833556fe572646daf2c3901fae2c9c17c15a99c1624ffbb586f67e
|
|
BLAKE2b-256 checksum How to use checksums |
facb6b349926bc3fb230548ad1209d0043abdda562e9a5ce21a74e28b98fcb2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.0
|
Release files / upiano-0.1.2-py3-none-any.whl
| Download URL | upiano-0.1.2-py3-none-any.whl |
|---|---|
| Size | 28.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b8033cb7a257522eaec496ffd46316b1fe21772112a500e5f561f62187c9befb
|
|
BLAKE2b-256 checksum How to use checksums |
5b35f48ff792b9ed764dd51ff70276609f04405a04e3d147d1a8c376ca4315f1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.0
|
Security for upiano 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.