# 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:
```bash
pip install wheelsmith
```
Alternatively, you can clone the GitHub repository and install WheelSmith locally:
```bash
git clone https://github.com/thtskaran/wheelsmith.git
cd wheelsmith
pip install -e .
```
## Usage
1. Navigate to the root directory of your Python package.
2. Run the following command:
```bash
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:
```bash
python -m wheelsmith
```
3. When prompted, enter your PyPI API token.
4. WheelSmith will build the package by running `python setup.py sdist bdist_wheel`.
5. After the build is successful, WheelSmith will upload the package to PyPI using `twine upload`.
6. 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](https://opensource.org/license/mit).
Raw data
{
"_id": null,
"home_page": null,
"name": "wheelsmith",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, packaging, pypi, wheels, publishing",
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/9f/80/c3af63943967be9fdf28c8c01ae5faea838099ec464593a9a3ed454e7472/wheelsmith-0.1.1.tar.gz",
"platform": null,
"description": "\n# WheelSmith\n\nWheelSmith 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.\n\n## Features\n\n- **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.\n- **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.\n- **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.\n- **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.\n- **Error Handling**: WheelSmith gracefully handles errors that may occur during the build or upload processes, displaying clear error messages in a user-friendly manner.\n\n## Installation\n\nYou can install WheelSmith using pip:\n\n```bash\npip install wheelsmith\n```\n\nAlternatively, you can clone the GitHub repository and install WheelSmith locally:\n\n```bash\ngit clone https://github.com/thtskaran/wheelsmith.git\ncd wheelsmith\npip install -e .\n```\n\n## Usage\n\n1. Navigate to the root directory of your Python package.\n2. Run the following command:\n\n```bash\nwheelsmith\n```\n\nIf WheelSmith hasn't been added to your system's PATH, you might need to use the following command while being in the project directory:\n\n```bash\npython -m wheelsmith\n```\n\n3. When prompted, enter your PyPI API token.\n4. WheelSmith will build the package by running `python setup.py sdist bdist_wheel`.\n5. After the build is successful, WheelSmith will upload the package to PyPI using `twine upload`.\n6. Progress bars and status messages will be displayed throughout the process.\n\n## Contributing\n\nContributions 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.\n\n## License\n\nWheelSmith is released under the [MIT License](https://opensource.org/license/mit).\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A utility tool for building and publishing Python packages to PyPI",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"python",
" packaging",
" pypi",
" wheels",
" publishing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c39c5eb7901616f8fba769c77fdfc68b68a011a31781042757da8b22b076daf",
"md5": "a76bfb0726a668e3fc381c715b84ab89",
"sha256": "ae13f3c68286302aebdf955e355e2481a2ecfaee2db48ca3dea3a85a99e59ca9"
},
"downloads": -1,
"filename": "wheelsmith-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a76bfb0726a668e3fc381c715b84ab89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3942,
"upload_time": "2024-04-01T15:48:30",
"upload_time_iso_8601": "2024-04-01T15:48:30.992255Z",
"url": "https://files.pythonhosted.org/packages/4c/39/c5eb7901616f8fba769c77fdfc68b68a011a31781042757da8b22b076daf/wheelsmith-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f80c3af63943967be9fdf28c8c01ae5faea838099ec464593a9a3ed454e7472",
"md5": "7df2d1656151cfd6b99dd28e810c9321",
"sha256": "88e4243ebf0b59fd8d157b5810872ac9a664454be1165fd93ab947d5c87569ff"
},
"downloads": -1,
"filename": "wheelsmith-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "7df2d1656151cfd6b99dd28e810c9321",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3730,
"upload_time": "2024-04-01T15:48:32",
"upload_time_iso_8601": "2024-04-01T15:48:32.133571Z",
"url": "https://files.pythonhosted.org/packages/9f/80/c3af63943967be9fdf28c8c01ae5faea838099ec464593a9a3ed454e7472/wheelsmith-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 15:48:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "wheelsmith"
}
JSON