Skip to main content

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

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitsummary-0.0.2.3.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

gitsummary-0.0.2.3-py3-none-any.whl (3.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page