Git advice for online documentation

[DamienIrving]

It might be worth adding some notes to the online documentation to explain how to automate adding some git information to command logs.

1. Install gitpython

$ conda install gitpython

2. Use sys.path[0] (which returns the directory your script is in) to get the repository directory. (If your script isn't in the top level directory of the repo, you might need to use something like repo_dir = '/'.join(script_dir.split('/')[:-1])):

import sys
repo_dir = sys.path[0]
import git

print(repo_dir)

/Users/damien/Desktop/data-carpentry

3. Now access information like the git hash and code url:

repo = git.Repo(repo_dir)
hash = str(repo.heads[0].commit)
print(hash)

b7f46dafe58cd3be5118766816a3fc190f21a50b

code_url = repo.remotes[0].url.split('.git')[0]
print(code_url)

https://github.com/DamienIrving/data-carpentry

4. Add that information to the new log:

import cmdline_provenance as cmdprov

cmdprov.new_log(code_url=code_url, extra_notes=[f'Git hash: {hash}'])

Fri Apr 16 11:56:38 2021: /Users/damien/opt/anaconda3/envs/pyaos-lesson/bin/jupyter notebook /Users/damien/Desktop/data-carpentry/Untitled.ipynb (https://github.com/DamienIrving/data-carpentry)
Extra notes:
Git hash: b7f46dafe58cd3be5118766816a3fc190f21a50b