Code Monkey home page Code Monkey logo

wheelsmith's Introduction

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

  1. Navigate to the root directory of your Python package.
  2. 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
  1. When prompted, enter your PyPI API token.
  2. WheelSmith will build the package by running python setup.py sdist bdist_wheel.
  3. After the build is successful, WheelSmith will upload the package to PyPI using twine upload.
  4. 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 APACHE LICENSE 2.0.

wheelsmith's People

Contributors

thtskaran avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.