Skip to content

Commit 1de457c

Browse files
authored
Update README.md
1 parent d0536a7 commit 1de457c

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
1-
# MyPortalDataMine
2-
This is a repo that contains a datamine of Foothill De Anza course data
1+
# MyPortal Data Mine
2+
3+
Contained in this repo is a list of JSON served in the [OwlAPI](https://github.com/OpenCourseAPI/OwlAPI) format. It can be accessed with [TinyDB](https://tinydb.readthedocs.io/en/latest/getting-started.html#basic-usage) using the documentation provided here.
4+
5+
**Note**: This data in is a state of flux. Production code should not be considered stable using this dataset. As we move to a move stable version of the data, we will update this repo.
6+
7+
## Setup
8+
9+
#### Install Pipenv
10+
> `pip install pipenv`
11+
12+
#### Install TinyDB
13+
> `pipenv install TinyDB`
14+
15+
#### Start the pipenv Virtual Env
16+
> `pipenv shell`
17+
18+
## Interfacing with TinyDB
19+
20+
`[add documentation]`

0 commit comments

Comments
 (0)