Streamlit component that allows you to play piano
Project description
streamlit-custom-component
Streamlit component that allows you to play MIDI.
Installation instructions
pip install streamlit-pianoroll
Usage instructions
import streamlit as st
from pianoroll_streamlit import pianoroll
st.write("This is a pianoroll!")
pianoroll()
Development instructions
- Initialize and run the component template frontend:
$ cd pianoroll_streamlit/frontend
$ npm install # Install npm dependencies
$ npm run start # Start the Webpack dev server
- From a separate terminal, run the template's Streamlit app:
$ cd template
$ . venv/bin/activate # activate the venv you created earlier
$ pip install -e . # install template as editable package
$ streamlit run streamlit_pianoroll/example.py # run the example
- If all goes well, you should see something like this:
Code Style
This repository uses pre-commit hooks with forced python formatting (black, flake8, and isort):
pip install pre-commit
pre-commit install
Whenever you execute git commit
the files altered / added within the commit will be checked and corrected.
black
and isort
can modify files locally - if that happens you have to git add
them again.
You might also be prompted to introduce some fixes manually.
To run the hooks against all files without running git commit
:
pre-commit run --all-files
Publishing
# Prepare JS
cd streamlit_pianoroll/frontend
npm run build
cd ../..
# Releasey PYPI
python setup.py sdist bdist_wheel
python -m twine upload --repository pypi dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
streamlit-pianoroll-0.6.0.tar.gz
(302.4 kB
view hashes)
Built Distribution
Close
Hashes for streamlit-pianoroll-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3482330f1b9e9c9f0c4ff515bf454833835f943f1e636cbb5f5f337490de4e5c |
|
MD5 | 5a6ffeaffbd20726c40ce1ade36d521d |
|
BLAKE2b-256 | a337557028c052bafde2e0af82e40fbff015f94eca30de408b0a6e6d2980dd6f |
Close
Hashes for streamlit_pianoroll-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b10105b0462be4c1e5c3a8f9ef4812d4535414c502b540f6037b094ad00b1fba |
|
MD5 | 6765716f950a07a893862dfe494bc7bb |
|
BLAKE2b-256 | 6e56a6c78ed26a9cbd51d011b80418bd47772cd11b8d83d3cef868ffc026b688 |