gitsummary-Timothy-W-Hilton 0.0.1

print a one-list summary of the current git repository, the current branch, and the hash for the current head

gitsummary

Pure python utility to print a one-line summary of the current git repository, the current branch, and the hash for the current head.

usage

import gitsummary
gitsummary.print_cwd_git_version()

returns a string containing the current git repository, the current branch, and the hash of the branch head. This information is useful in scientific codes to quickly determine the origin of a plot or dataset. The string can, for example, be written in a jupyter notebook or placed in the metadata of a netcdf file.

License

This project is licensed under the terms of the MIT license.