File tree Expand file tree Collapse file tree 1 file changed +33
-1
lines changed Expand file tree Collapse file tree 1 file changed +33
-1
lines changed Original file line number Diff line number Diff line change @@ -50,11 +50,43 @@ Basic mode
5050 pip install -e .
5151
5252 Dev mode
53- ^^^^^^^^^^
53+ ^^^^^^^^
5454.. code :: sh
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 a sample database containing example project files.
63+ DVC can be 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 access to the sample database stored on google drive is currently restricted. Access requires a :code: `gdrive_client_secret `
65+ for user access authentication to be shared by developers.
66+
67+ DVC usage
68+ ~~~~~~~~~
69+
70+ To download the sample database:
71+
72+ .. code :: sh
73+
74+ git pull
75+ dvc remote modify shared_gdrive gdrive_client_secret < client_secret_here> # Contact developers for grive_client_secret
76+ dvc pull # Requires access to remote storage
77+
78+ This will download a directory 'db_dvc' in the repo directory that
79+ contains the corresponding version of example database files.
80+
81+ To commit updates to the sample database:
82+
83+ .. code :: sh
84+
85+ dvc add db_dvc
86+ git commit -m " Describe updates to database"
87+ git push
88+ dvc push # Requires access to remote storage
89+
5890 Disclaimer
5991----------
6092
You can’t perform that action at this time.
0 commit comments