Welcome to verbose-version-info’s documentation!

verbose-version-info

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!

Installation

Stable release

To install verbose-version-info, run this command in your terminal:

$ pip install verbose_version_info

This is the preferred method to install verbose-version-info, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for verbose-version-info can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/s-weigand/verbose-version-info

Or download the tarball:

$ curl -OJL https://github.com/s-weigand/verbose-version-info/tarball/main

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use verbose-version-info in a project:

import verbose_version_info

Inner workings

This is the detailed documentation of the inner workings of verbose_version_info.

verbose_version_info

Top-level package for verbose-version-info.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/s-weigand/verbose-version-info/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

verbose-version-info could always use more documentation, whether as part of the official verbose-version-info docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/s-weigand/verbose-version-info/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up verbose_version_info for local development.

Fork the verbose-version-info repo on GitHub.

Clone your fork locally:

$ git clone --recursive git@github.com:your_name_here/verbose_version_info.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv verbose_version_info
$ cd verbose-version-info/
$ pip install -e .
```

install the pre-commit and pre-push hooks:

$ pre-commit install && pre-commit install -t pre-push

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
The pull request should work for Python 3.8, 3.9, 3.10 and 3.11, and for PyPy. Check https://github.com/s-weigand/verbose-version-info/actions and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_verbose_version_info

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push --follow-tags

Travis will then deploy to PyPI if tests pass.

History

0.0.1 (2021-02-18)

First release on PyPI.