verbose-version-info

License

Actions Status Documentation Status codecov Documentation Coverage

All Contributors Code style Python: black

Generate verbose version information for python packages

  • Free software: Apache Software License 2.0

  • Documentation: https://verbose-version-info.readthedocs.io.

Features

Implemented

  • Basic version retrieval

  • Customizable string for not found version

  • Commit_id for pip install git+<url>

  • Split off cli to an extra

  • Detect pip install -e installation and get path

  • commit id for pip install -e . if .git exists

  • commit id for pip install . if .git exists

  • Determine dist time for pip install . (needed for better commit_id)

  • get commit id for pip install . if .git exists, for the closest commit at installation time

  • use find_url_info in vv_info for tarball installation

  • Add dist_mtime time to VerboseVersionInfo

  • Add warning if repo of source install is dirty (git status -s != "" )

TODO

  • Use a Singleton class instead of dicts for settings

  • Reset settings function (mostly notebook showoff)

  • setting formatter: Mapping[str, format_function] (used for sha)

  • extract minimal required versions (useful for CI tests, of the min version)

  • export minimal requirements to file (pip or conda style)

  • add conda support

  • create github markdown summary

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Sebastian Weigand
💻 🤔 🚧 📆 🚇 ⚠️ 📖

This project follows the all-contributors specification. Contributions of any kind welcome!