A utility tool for building and publishing Python packages to PyPI
Project description
WheelSmith
WheelSmith is a command-line utility tool designed to simplify the process of building and publishing Python packages to the Python Package Index (PyPI). It combines the steps of creating source distributions, building wheels, and uploading the package to PyPI into a single command, making it easier for developers to distribute their Python projects. With WheelSmith, you can save countless clicks and make publishing to PyPI easier than ever before, with just a single stroke.
Features
- Single Command Publishing: With WheelSmith, you can build and publish your Python package to PyPI with just one command, eliminating the need to run multiple steps manually.
- Secure API Token Handling: WheelSmith prompts you to enter your PyPI API token securely using the
getpass
module, ensuring that your credentials are not exposed in plain text. - Progress Monitoring: WheelSmith utilizes the
tqdm
library to display progress bars during the build and upload processes, providing visual feedback on the operation's status. - Rich Output: The tool leverages the
rich
library to display colorful and formatted output, making it easier to distinguish between different stages of the publishing process. - Error Handling: WheelSmith gracefully handles errors that may occur during the build or upload processes, displaying clear error messages in a user-friendly manner.
Installation
You can install WheelSmith using pip:
pip install wheelsmith
Alternatively, you can clone the GitHub repository and install WheelSmith locally:
git clone https://github.com/thtskaran/wheelsmith.git
cd wheelsmith
pip install -e .
Usage
- Navigate to the root directory of your Python package.
- Run the following command:
wheelsmith
If WheelSmith hasn't been added to your system's PATH, you might need to use the following command while being in the project directory:
python -m wheelsmith
- When prompted, enter your PyPI API token.
- WheelSmith will build the package by running
python setup.py sdist bdist_wheel
. - After the build is successful, WheelSmith will upload the package to PyPI using
twine upload
. - Progress bars and status messages will be displayed throughout the process.
Contributing
Contributions to WheelSmith are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request on the project's GitHub repository.
License
WheelSmith is released under the MIT License.
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
Built Distribution
File details
Details for the file wheelsmith-0.1.1.tar.gz
.
File metadata
- Download URL: wheelsmith-0.1.1.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88e4243ebf0b59fd8d157b5810872ac9a664454be1165fd93ab947d5c87569ff |
|
MD5 | 7df2d1656151cfd6b99dd28e810c9321 |
|
BLAKE2b-256 | 9f80c3af63943967be9fdf28c8c01ae5faea838099ec464593a9a3ed454e7472 |
File details
Details for the file wheelsmith-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: wheelsmith-0.1.1-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae13f3c68286302aebdf955e355e2481a2ecfaee2db48ca3dea3a85a99e59ca9 |
|
MD5 | a76bfb0726a668e3fc381c715b84ab89 |
|
BLAKE2b-256 | 4c39c5eb7901616f8fba769c77fdfc68b68a011a31781042757da8b22b076daf |