Skip to content

CHANGELOG.md

Latest commit

 

History

History
158 lines (89 loc) · 4.81 KB

CHANGELOG.md

File metadata and controls

158 lines (89 loc) · 4.81 KB

🔄 Change

  • .github/workflows/publish_release.yml: add skip-existing: true to skip publishing when there exists a same version package.
  • MANIFEST.in: exclude shell files from the package.

🎉 Support pyproject.toml

see assets below.

🔄 Change

  • .github/CONTRIBUTING.md: add suggestion for creating a new branch to submit PR.

🌟 Add

  1. .github/workflows/publish_release.yml : enable continuous deployment(CD) workflows for automatic package building, publishing, and creating GitHub releases.

🌟 Add

  1. .github/CONTRIBUTING.md : guide other to make contribution to your project.

  2. .github/ISSUE_TEMPLATE : standardize the format of issue reporting. Composed of bug_report.yml, feature_request.yml and config.yml.

  3. .github/PULL_REQUEST_TEMPLATE.md : standardize the format of Pull Request.

🌟 Add

  • docs/README.md: instructions for docs, provide some tool suggestions to help you quickly build your own document.
  • tests/README.md: instructions for testing, provide the whole procedure of testing.
  • examples/demo.ipynb: provide an example of how to demonstrate your project.

🗑️ Delete

  • docs/.gitkeep
  • tests/.gitkeep
  • examples/.gitkeep

🔄 Change

  • packaging.sh: add logit of deleting the old distribution packages.
  • README.md: add 🧰 Tools Recommended section.

🔄 Change

  • check_meta.sh: rectify logit of getting Metadata-Version
  • README.md: rectify usage of keyring.

🎉 Support manual package maintenance

Including construction, inspection, and publishing to PyPI.
Please refer to steps 6 through 8 in README.md file.

🔄 Change

  • setup.py: keep a minimal setting to ensure editable installation supported
  • README.md: finish full pipeline of package development.
  • requirements.txt: add more example dependencies.
  • ruff.toml: target-version set to "py37", cause it is the minimum requirement.

🌟 Add

  • setup.cfg: define the configuration of the build process
  • packaging.sh: auto build the distribution packages.
  • check_meta.sh: auto check the meta information of the built distribution packages.

🔄 Change

  • README.md: Added more information and beautified it.
  • setu.py: add SETUP_REQUIRED

🌟 Add

  • CHANGELOG.md: record version changes.
  • ruff.toml: define rules for code style, code inspection, and import management

🔄 Change

  • Fix bugs in setup.py: Optimized the logic of dynamically obtaining version information, removed the extended function class UploadCommand(Cause setpu.py no longer supports functional customization, see more)
  • Fix bugs in MANIFEST.in: Discard unnecessary commands
  • <package-name>/__init__.py: Added copyright definition and version definition
  • requirements.txt: Added example dependencies
  • README.md: Added more information and beautified it.

🗑️ Delete

  • <package-name>/__version__.py

🎉 Preliminarily establish the project framework.

🎯 Features

  • A relatively complete software engineering project structure, including directories for code, test, document, and project demonstration

  • setup.py is a collection of useful patterns and best practices. It extends the python setup.py command to achieve one-step code updates, package builds, and releases to PyPi using Twine.