Tspng

Features and enhancements

- Changed package version ([81](https://github.com/Theia-Scientific/tspng/pull/81))
- Removed Python v3.8 support ([86](https://github.com/Theia-Scientific/tspng/pull/86))
- Removed `requirements.txt` file ([85](https://github.com/Theia-Scientific/tspng/pull/85))

Bug fixes

- Fixed automated publishing workflow ([80](https://github.com/Theia-Scientific/tspng/pull/80))

Features and enhancements

- Added initial Command Line Interface (CLI) with extract subcommand ([78](https://github.com/Theia-Scientific/tspng/pull/78))
- Changed to using function argument ([77](https://github.com/Theia-Scientific/tspng/pull/77))

Features and enhancements

- Added an implantation module ([71](https://github.com/Theia-Scientific/tspng/pull/71))
- Added create and pushing package to PyPI.org to release workflow ([68](https://github.com/Theia-Scientific/tspng/pull/68))
- Changed name field in workflow configuration ([70](https://github.com/Theia-Scientific/tspng/pull/70))
- Changed name of repository ([74](https://github.com/Theia-Scientific/tspng/pull/74))
- Changed `python-package.yml` to `ci.yml` ([69](https://github.com/Theia-Scientific/tspng/pull/69))

Features and enhancements

- Added `extract_from_url` function ([65](https://github.com/Theia-Scientific/theia-png/pull/65))
- Created a release procedure ([64](https://github.com/Theia-Scientific/theia-png/pull/64))

Features and enhancements

- Added docstring documentation to all functions ([47](https://github.com/Theia-Scientific/theia-png/pull/47))
- Added extract_from_bytes function ([54](https://github.com/Theia-Scientific/theia-png/pull/54))
- Added extract_from_files function ([46](https://github.com/Theia-Scientific/theia-png/pull/46))
- Added extract_from_folder function ([57](https://github.com/Theia-Scientific/theia-png/pull/57))
- Added parameter validation to extract functions ([52](https://github.com/Theia-Scientific/theia-png/pull/52))
- Added parent extract function ([55](https://github.com/Theia-Scientific/theia-png/pull/55))
- Added Release GitHub workflow ([59](https://github.com/Theia-Scientific/theia-png/pull/59))
- Added type annotations ([48](https://github.com/Theia-Scientific/theia-png/pull/48))
- Added unit tests for errors in extraction.py ([58](https://github.com/Theia-Scientific/theia-png/pull/58))
- Added version limit to Pillow requirement ([61](https://github.com/Theia-Scientific/theia-png/pull/61))
- Added virtual environment step to Contributing ([44](https://github.com/Theia-Scientific/theia-png/pull/44))
- Changed extract function to extract_from_file ([45](https://github.com/Theia-Scientific/theia-png/pull/45))

Initial release


tspng Python Package Release Procedure

Procedure for releasing a new `tspng` package on GitHub and on the Python
Package Index (PyPI).

GitHub Release

1. Add changes made since the previous release to `CHANGELOG.md` by referring to
the closed pull requests. The header should have 'IN PROGRESS' in the date
section.
2. Commit this change with the message 'Add changes to documentation'.
3. Change the date in `CHANGELOG.md` to the current date in the format YYYY-MM-DD.
4. Commit this change with the message 'Add release date'.
5. Change the package version in both `pyproject.toml` and `setup.py`.
6. Commit these changes with the message 'Bump package version'.
7. Publish the branch and create the pull request.
8. When the PR is approved, squash and merge the PR and locally pull the updated
repository.

sh
git checkout main && git pull


9. Create the release tag.

sh
git tag -a v.. -m ".. (YYYY-MM-DD)"


where `..` is replaced with the version number and `YYYY-MM-DD` is
replaced with the year, month, and day, respectively.

10. Push the tags.

sh
git push --tags


11. Go to the draft of the release on Github and publish it.
12. Create the next milestone, move Open issues to the next milestone, and close
the previous milestone.

PyPI Release

1. Pull the latest changes from the repository.

sh
git checkout main && git pull


2. Activate the virtual environment.

sh
source .venv/bin/activate


3. Remove all files in the `dist` folder.

sh
rm ./dist/*


4. Build the wheel.

sh
python3 -m build ./


5. Upload the build and enter PyPI credentials when prompted.

sh
twine upload dist/*