QRClipboard is a Python package that creates QR codes from the contents of the clipboard.
To install the package, follow these steps:
-
First, create the package by running the
make build
command. This command will generate the source distribution (sdist
) and wheel (bdist_wheel
) for the package. -
Once the package is built, you can install it using
pipx
with themake install
command. This command installs the package in an isolated environment to avoid any conflicts with other packages.
After installing the package, you can execute it using the qrclip
command:
qrclip
This command will read the current content of the clipboard, generate a QR code from it, and display the QR code.
To contribute to this project, follow these steps:
- Fork the repository on GitHub.
- Create a new branch for your feature or bug fix:
git checkout -b feature-new-feature
- Make your changes and commit them with a meaningful message:
git commit -m 'Add new feature'
- Push your changes to GitHub:
git push origin feature-new-feature
- Open a pull request on GitHub to merge your changes.
The project includes a Makefile
that simplifies various tasks:
-
To build the package, use
make build
. This command runs thesetup.py
script to create the source distribution and wheel for the package. -
To install the package, use
make install
. This command utilizespipx
to install the package in an isolated environment. -
To uninstall the package, use
make uninstall
. This command removes the package installed bypipx
. -
To clean the build directories, use
make clean
. This command deletes thebuild
,dist
, and.egg-info
directories to ensure a clean state. -
To run unit tests, use
make test
. This command executes all unit tests located in thetests
directory to verify that the package works as expected. -
To upload the package to PyPI, use
make upload
. This command usestwine
to upload the built distributions to the Python Package Index (PyPI). This step is optional and requires thetwine
module to be installed. -
To run the main script of the package, use
make run
. This command executes the main function defined in theQRClipboard.main
module.
This project is licensed under the MIT License. For more details, refer to the LICENSE
file.