Metadata-Version: 2.1
Name: gitsummary
Version: 0.0.2.2
Summary: print a one-list summary of the current git repository, the current branch, and the hash for the current head
Home-page: https://github.com/Timothy-W-Hilton/gitsummary
Author: Timothy W. Hilton
Author-email: t.hilton@gns.cri.nz
Project-URL: Bug Tracker, https://github.com/Timothy-W-Hilton/gitsummary/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt

## 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

``` python
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](https://jupyter.org/) or placed in the metadata of a [netcdf](https://www.unidata.ucar.edu/software/netcdf/) file.  

## License

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