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:
1. **Setup Enhancement**:
- Introduced a robust setup process using `python -m build` to 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.
2. **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 `--repository` flag.
3. **Installation Instructions**:
- Provided clear guidelines for installing packages from TestPyPI using pip with the `--index-url` flag.
Instructions for Maintainers:
1. **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.
2. **Running the Build and Upload**:
- Execute the build command to package the project:
sh
python -m build
- Upload the built distributions to PyPI using:
sh
twine upload dist/*
3. **Testing on TestPyPI**:
- Upload to TestPyPI (optional):
sh
twine upload --repository testpypi dist/*