- Oliver Bonham-Carter, Web
- email: obonhamcarter@allegheny.edu
- Date: 7th December 2024
- The whole project was written in poetry and uses the Streamlit and the qrcode library. Poetry manages these libraries for you so that you never have to think about them!
- To engage poetry initially, use the following command from the root of the project. Note: the root of the project is the directory where the file,
pyproject.toml
resides.
poetry install
Below are commands to run MyQR using a Poetry virtual environment that manages all necessary libraries and software for MyQR to run.
- Basic help to run the project
poetry run myqr --help
- Involved help to run the project
poetry run myqr --bighelp
- Actual command to engage the program
poetry run myqr --client qr
- Enter the text to encode in a QR code
- Pick your colours
- Select size and boarder width of the qr
.png
file - Select the
Generate QR Code
button. - View the QRcode as a
.png
image that will appear. - Check the output directory:
0_out/
for your.png
file, or save it by right-clicking on the image itself.
Check back often to see the evolution of the project!! If you would like to contribute to this project, then please do! For instance, if you see some low-hanging fruit or task that you could easily complete, that could add value to the project, then I would love to have your insight.
Otherwise, please create an Issue for bugs or errors. Since I am a teaching faculty member at Allegheny College, I may not have all the time necessary to quickly fix the bugs and so I would be very happy to have any help that I can get from the OpenSource community for any technological insight. Much thanks in advance. I hope that this project helps you find the knowledge from PubMed that you require for your project. :-)