abstract_modules allows you to easily upload your Python module to the Python Package Index (PyPI) using Twine. It automates several steps of the packaging and distribution process, making it easier to share your module with the Python community..
Project description
#abstract_modules
Python Module Upload to PyPI
This utility script allows you to easily upload your Python module to the Python Package Index (PyPI) using Twine. It automates several steps of the packaging and distribution process, making it easier to share your module with the Python community.
Prerequisites
Before using this script, ensure you have the following prerequisites:
-
Python 3.x installed on your system
-
twine
,build
,abstract_utilities
,abstract_gui
andpexpect
packages installed. You can install them usingpip
:pip install twine build pexpect
Getting Started
-
Clone the repository or download the script file (
upload_to_pypi.py
) to your local machine. -
Navigate to the directory where your Python module is located using the command line.
-
Optional: If you use a virtual environment, activate it before proceeding.
Usage
Run the script upload_to_pypi.py
with Python 3:
python3 upload_to_pypi.py
The script will guide you through the following steps:
-
Selecting Module Directory: You will be prompted to pick the module directory using a GUI window. This directory should contain the necessary files, including the
setup.py
file. -
Updating Version Number: If the version number in the
setup.py
file matches an existing version in thedist
directory, you will be asked to enter a new version number. -
Building the Module: The script will build your module using the
setup.py
script. The distribution files (wheels) will be placed in thedist
directory.
-
Uploading to PyPI: The script will prompt you to enter your PyPI username and password securely. It will then upload the module to PyPI using Twine.
-
Installing the Module: After successful upload, you will have the option to install the module using pip for testing purposes.
Example
$ python3 upload_to_pypi.py
# Output will guide you through the process
Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please feel free to create an issue or submit a pull request.
License
This utility script is open-source and distributed under the MIT License.
Acknowledgments
This script utilizes the following packages and resources:
- pexpect - For automating interactive command-line applications.
- Twine - For securely uploading Python packages to PyPI.
- Python - The Python programming language.
Disclaimer
This script is provided "as is" without warranty of any kind. Use it at your own risk.
Support
If you encounter any issues or need assistance, please create an issue or seek support in the Python community forums.
Thank you for using our utility script! If you have any feedback or questions, don't hesitate to contact us. Happy packaging and distributing!
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 abstract_modules-0.0.3.77.tar.gz
.
File metadata
- Download URL: abstract_modules-0.0.3.77.tar.gz
- Upload date:
- Size: 38.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e655d61162a507c119a8a9013c9a6627f7e541dab6f98374ff3a9d3860a21bf |
|
MD5 | ff8aff70b8cb9fd2aa6d9bca46dbdd54 |
|
BLAKE2b-256 | bbe935be1a72290616d8df7adaf8d2d043b0374fa6ffc0779fa5181f9d747937 |
File details
Details for the file abstract_modules-0.0.3.77-py3-none-any.whl
.
File metadata
- Download URL: abstract_modules-0.0.3.77-py3-none-any.whl
- Upload date:
- Size: 38.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c332bee13647069c1f7cfdad07eb0ddd2cedf1ded895a71e31ba2a2f76136be |
|
MD5 | e6fae92eac8f39960c6612764aa3bea3 |
|
BLAKE2b-256 | d736c33769cc259342b816888546dca1d203e741c97e3e79a83e469739551d0b |