Merge pull request #38 from ECN/staging

v1.0 RC
ECN · Jul 1, 2021 · 232fc14 · 232fc14
2 parents 0bb672a + 3917396
commit 232fc14
Show file tree

Hide file tree

Showing 48 changed files with 3,197 additions and 1,673 deletions.
diff --git a/.gitignore b/.gitignore
@@ -71,9 +71,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
-
 # PyBuilder
 target/
 
@@ -121,7 +118,7 @@ venv.bak/
 .ropeproject
 
 # mkdocs documentation
-/site
+/docs
 
 # mypy
 .mypy_cache/

diff --git a/README.md b/README.md
@@ -19,3 +19,22 @@ For example, to install version 0.9.1:
 ```
 git+https://github.itap.purdue.edu/ECN/webqueue2-api@0.9.1#egg=webqueue2-api
 ```
+
+## Contributing
+1. Clone the git repo:
+```bash
+git clone https://github.itap.purdue.edu/ECN/webqueue2-api.git
+```
+2. Create and activate Python virtual environment:
+```bash
+python3 -m venv venv
+source venv/bin/activate
+```
+3. Install dependencies:
+```bash
+# Older versions of pip may fail to install newer packages.
+pip install -U pip
+# Install the webqueue2-api package in editable mode with all extra packages.
+pip install -e .[all]
+```
+4. Make changes and create a PR.
diff --git a/__init__.py b/__init__.py
diff --git a/api.py b/api.py