Repository navigation
0.1 Release
·
10 commits
to master
since this release
Release Description for PythonDocxAJM
Version: 0.1
Overview
This release includes important updates and improvements for the PythonDocxAJM project, ensuring better distribution management, streamlined project setup, and easier package uploads to PyPI.
Key Features:
-
Setup Enhancement:
- Introduced a robust setup process using
python -m buildto create source distributions (sdist). - Validated and ensured the presence of crucial files (
LICENSE.txt,README.md,setup.cfg,setup.py) for package consistency and compliance.
- Introduced a robust setup process using
-
Automated Distribution Upload:
- Simplified the process of uploading package distributions to PyPI using
twine. - Enabled seamless uploads to PyPI with user authentication via token (
__token__). - Added instructions for uploading to TestPyPI for testing purposes with the
--repositoryflag.
- Simplified the process of uploading package distributions to PyPI using
-
Installation Instructions:
- Provided clear guidelines for installing packages from TestPyPI using pip with the
--index-urlflag.
- Provided clear guidelines for installing packages from TestPyPI using pip with the
Instructions for Maintainers:
-
Pre-upload Checklist:
- Ensure all necessary files (
LICENSE.txt,README.md,setup.cfg,setup.py) are updated. - Commit changes to the remote repository.
- Create a new release tag on the remote repository.
- Ensure all necessary files (
-
Running the Build and Upload:
- Execute the build command to package the project:
python -m build
- Upload the built distributions to PyPI using:
twine upload dist/*
- Execute the build command to package the project:
-
Testing on TestPyPI:
- Upload to TestPyPI (optional):
twine upload --repository testpypi dist/*
- Upload to TestPyPI (optional):