Skip to content

Commit 2d82c07

Browse files
committed
Add dvc usage instructions to README.rst (#122)
1 parent cfc6cfe commit 2d82c07

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,37 @@ Dev mode
5555
5656
pip install -e .[dev]
5757
58+
Version control of database using DVC (Data Version Control)
59+
------------
60+
61+
Data Version Control (DVC) is a data management tool that is meant to be run alongside Git.
62+
In this project DVC is used to link changes in the code to specific versions of the database. DVC can be
63+
used when this project is installed in Dev mode. You can read more about DVC and how to use it `here <https://dvc.org/doc/start>`_.
64+
Note: Remote storage of the database currently uses google drive storage that requires a "gdrive_client_secret"
65+
for user access authentication.
66+
67+
DVC usage
68+
^^^^^^^^^
69+
70+
To download the database:
71+
72+
.. code:: sh
73+
74+
git pull
75+
dvc pull # Requires access to remote storage
76+
77+
This will download a directory 'db_dvc' in the repo directory that
78+
contains the corresponding version of database files.
79+
80+
To commit updates to the database:
81+
82+
.. code:: sh
83+
84+
dvc add db_dvc
85+
git commit -m "Describe updates to database"
86+
git push
87+
dvc push #Requires access to remote storage
88+
5889
Disclaimer
5990
----------
6091

0 commit comments

Comments
 (0)