Skip to content

Commit a0f91a6

Browse files
authored
Update README.md
1 parent 5a341d1 commit a0f91a6

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
# dspace-data-collection
22

3-
expects a secrets.py file something like the following:
3+
All of these scripts require a secrets.py file in the same directory that must contain the following text:
44
```
55
baseURL='https://dspace.myuni.edu'
6-
# credentials for an authorized dspace user
76
email='dspace_user@.myuni.edu'
8-
password='my_dspace_password'
9-
# full path to a directory into which to store output
10-
filePath = '/Users/dspace_user/dspace-data-collection/data/'
11-
# handlePrefix may vary from your dspace url (or may not)
12-
handlePrefix = 'http://dspace.myuni.edu/handle/'
7+
password='my_dspace_password'
8+
filePath = '/Users/dspace_user/dspace-data-collection/data/' # full path to a directory into which to store output files
9+
handlePrefix = 'http://dspace.myuni.edu/handle/' # handlePrefix may vary from your dspace url (or may not)
1310
```
14-
this file will be gitignored.
11+
This secrets.py file will be ignored according to the repository's .gitignore file so that DSpace login details will not be inadvertently exposed through Github
1512

1613
*Note that all of these scripts skip collection '24' for local reasons. To change this, edit the following portion of the script (typically between line 27-39)
1714

@@ -28,3 +25,23 @@ No collections skipped:
2825
collectionID = collections[j]['id']
2926
if collectionID != 0:
3027
offset = 0
28+
#### [compareTwoKeysInCommunity.py](compareTwoKeysInCommunity.py)
29+
30+
#### [findBogusUris.py](findBogusUris.py)
31+
32+
#### [findDuplicateKeys.py](findDuplicateKeys.py)
33+
34+
#### [getCollectionMetadataJson.py](getCollectionMetadataJson.py)
35+
36+
#### [getCompleteAndUniqueValuesForAllKeys.py](getCompleteAndUniqueValuesForAllKeys.py)
37+
38+
#### [getGlobalLanguageValues.py](getGlobalLanguageValues.py)
39+
40+
#### [getLanguageValuesForKeys.py](getLanguageValuesForKeys.py)
41+
42+
#### [getRecordsAndValuesForKey.py](getRecordsAndValuesForKey.py)
43+
44+
#### [getRecordsWithKeyAndValue.py](getRecordsWithKeyAndValue.py)
45+
46+
#### [metadataOverview.py](metadataOverview.py)
47+

0 commit comments

Comments
 (0)