Skip to content
Snippets Groups Projects
Commit 32b72639 authored by ferrari's avatar ferrari
Browse files

update README

parent 3a0f4058
Branches
No related tags found
No related merge requests found
......@@ -15,6 +15,8 @@ To uninstall, just type `pip uninstall auto_git_info`
Basic usage
-----
##### Python module
```python
from auto_git_info import log_info
import argparse
......@@ -38,6 +40,21 @@ The json file created will be:
"time": "2023-06-23T18:04:30.894271"}
```
##### Command line
Just launch the auto_git_info module followed by your python script and its arguments
as usual.
```
python -m auto_git_info your_script.py args1 ... -optn argsn
```
or if you want to change the default path:
```
python -m auto_git_info log_info=path.json your_script.py args1 ... -optn argsn
```
*Note that using this method will add `parsed_arguments=False` to the json*
Advance usage
-------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment