| Name | abstract-modules JSON |
| Version |
0.0.3.77
JSON |
| download |
| home_page | https://github.com/AbstractEndeavors/abstract_modules |
| Summary | 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.. |
| upload_time | 2024-10-23 06:08:16 |
| maintainer | None |
| docs_url | None |
| author | putkoff |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
#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` and `pexpect` packages installed. You can install them using `pip`:
```bash
pip install twine build pexpect
```
## Getting Started
1. Clone the repository or download the script file (`upload_to_pypi.py`) to your local machine.
2. Navigate to the directory where your Python module is located using the command line.
3. **Optional**: If you use a virtual environment, activate it before proceeding.
## Usage
Run the script `upload_to_pypi.py` with Python 3:
```bash
python3 upload_to_pypi.py
```
The script will guide you through the following steps:
1. **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.
2. **Updating Version Number**: If the version number in the `setup.py` file matches an existing version in the `dist` directory, you will be asked to enter a new version number.
3. **Building the Module**: The script will build your module using the `setup.py` script. The distribution files (wheels) will be placed in the `dist` directory.
4. **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.
5. **Installing the Module**: After successful upload, you will have the option to install the module using pip for testing purposes.
## Example
```bash
$ 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](LICENSE).
## Acknowledgments
This script utilizes the following packages and resources:
- [pexpect](https://pexpect.readthedocs.io/) - For automating interactive command-line applications.
- [Twine](https://twine.readthedocs.io/) - For securely uploading Python packages to PyPI.
- [Python](https://www.python.org/) - 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](https://github.com/AbstractEndeavors/abstract_essentials/tree/main/abstract_modules) 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!
Raw data
{
"_id": null,
"home_page": "https://github.com/AbstractEndeavors/abstract_modules",
"name": "abstract-modules",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "putkoff",
"author_email": "partners@abstractendeavors.com",
"download_url": "https://files.pythonhosted.org/packages/bb/e9/35be1a72290616d8df7adaf8d2d043b0374fa6ffc0779fa5181f9d747937/abstract_modules-0.0.3.77.tar.gz",
"platform": null,
"description": "#abstract_modules\n# Python Module Upload to PyPI\n\nThis 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.\n\n## Prerequisites\n\nBefore using this script, ensure you have the following prerequisites:\n\n- Python 3.x installed on your system\n- `twine`, `build`,`abstract_utilities`,`abstract_gui` and `pexpect` packages installed. You can install them using `pip`:\n\n ```bash\n pip install twine build pexpect\n ```\n\n## Getting Started\n\n1. Clone the repository or download the script file (`upload_to_pypi.py`) to your local machine.\n\n2. Navigate to the directory where your Python module is located using the command line.\n\n3. **Optional**: If you use a virtual environment, activate it before proceeding.\n\n## Usage\n\nRun the script `upload_to_pypi.py` with Python 3:\n\n```bash\npython3 upload_to_pypi.py\n```\n\nThe script will guide you through the following steps:\n\n1. **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.\n\n\n\n2. **Updating Version Number**: If the version number in the `setup.py` file matches an existing version in the `dist` directory, you will be asked to enter a new version number.\n\n\n\n3. **Building the Module**: The script will build your module using the `setup.py` script. The distribution files (wheels) will be placed in the `dist` directory.\n\n\n\n\n\n4. **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.\n\n5. **Installing the Module**: After successful upload, you will have the option to install the module using pip for testing purposes.\n\n\n\n\n## Example\n\n```bash\n$ python3 upload_to_pypi.py\n# Output will guide you through the process\n```\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvements, please feel free to create an issue or submit a pull request.\n\n## License\n\nThis utility script is open-source and distributed under the [MIT License](LICENSE).\n\n## Acknowledgments\n\nThis script utilizes the following packages and resources:\n\n- [pexpect](https://pexpect.readthedocs.io/) - For automating interactive command-line applications.\n- [Twine](https://twine.readthedocs.io/) - For securely uploading Python packages to PyPI.\n- [Python](https://www.python.org/) - The Python programming language.\n\n## Disclaimer\n\nThis script is provided \"as is\" without warranty of any kind. Use it at your own risk.\n\n## Support\n\nIf you encounter any issues or need assistance, please [create an issue](https://github.com/AbstractEndeavors/abstract_essentials/tree/main/abstract_modules) or seek support in the Python community forums.\n\n---\n\nThank you for using our utility script! If you have any feedback or questions, don't hesitate to contact us. Happy packaging and distributing!\n",
"bugtrack_url": null,
"license": null,
"summary": "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..",
"version": "0.0.3.77",
"project_urls": {
"Homepage": "https://github.com/AbstractEndeavors/abstract_modules"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d736c33769cc259342b816888546dca1d203e741c97e3e79a83e469739551d0b",
"md5": "e6fae92eac8f39960c6612764aa3bea3",
"sha256": "4c332bee13647069c1f7cfdad07eb0ddd2cedf1ded895a71e31ba2a2f76136be"
},
"downloads": -1,
"filename": "abstract_modules-0.0.3.77-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6fae92eac8f39960c6612764aa3bea3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 38867,
"upload_time": "2024-10-23T06:08:15",
"upload_time_iso_8601": "2024-10-23T06:08:15.125585Z",
"url": "https://files.pythonhosted.org/packages/d7/36/c33769cc259342b816888546dca1d203e741c97e3e79a83e469739551d0b/abstract_modules-0.0.3.77-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bbe935be1a72290616d8df7adaf8d2d043b0374fa6ffc0779fa5181f9d747937",
"md5": "ff8aff70b8cb9fd2aa6d9bca46dbdd54",
"sha256": "4e655d61162a507c119a8a9013c9a6627f7e541dab6f98374ff3a9d3860a21bf"
},
"downloads": -1,
"filename": "abstract_modules-0.0.3.77.tar.gz",
"has_sig": false,
"md5_digest": "ff8aff70b8cb9fd2aa6d9bca46dbdd54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 38470,
"upload_time": "2024-10-23T06:08:16",
"upload_time_iso_8601": "2024-10-23T06:08:16.707299Z",
"url": "https://files.pythonhosted.org/packages/bb/e9/35be1a72290616d8df7adaf8d2d043b0374fa6ffc0779fa5181f9d747937/abstract_modules-0.0.3.77.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 06:08:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AbstractEndeavors",
"github_project": "abstract_modules",
"github_not_found": true,
"lcname": "abstract-modules"
}
