Skip to content

Commit 6433c5c

Browse files
authored
Merge pull request #1 from dheles/docs_and_structure
Adds a little more documentation and structure
2 parents 94844ee + a37c771 commit 6433c5c

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,9 @@ $RECYCLE.BIN/
4545
Network Trash Folder
4646
Temporary Items
4747
.apdisk
48+
49+
# project-specific
4850
secrets.py
51+
*.pyc
52+
data/*
53+
!data/.keep

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,14 @@
11
# dspace-data-collection
2+
3+
expects a secrets.py file something like the following:
4+
```
5+
baseURL='https://dspace.myuni.edu'
6+
# credentials for an authorized dspace user
7+
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/'
13+
```
14+
this file will be gitignored.

data/.keep

Whitespace-only changes.

0 commit comments

Comments
 (0)