add some development information, add redis so you can even run (paci…

…fica#82) * add some development information, add redis so you can even run * add link to development doc to readme * add pre-commit polishing * Try a travis fix from: pypa/pip#6275
karcaw · Dec 11, 2019 · 727536b · 727536b
1 parent 80e4c98
commit 727536b
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -60,3 +60,6 @@ target/
 db.sqlite3
 
 .vscode
+
+#pyenv file
+.python-version
diff --git a/.travis.yml b/.travis.yml
@@ -72,3 +72,4 @@ jobs:
         tags: true
 install:
 - pip install -r requirements-dev.txt
+- python setup.py egg_info
diff --git a/README.md b/README.md
@@ -28,4 +28,5 @@ documentation.
 
 * [Installation](docs/installation.md) documentation.
 * [Configuration](docs/configuration.md) documentation.
+* [Development](docs/development.md) documentation.
 * [Examples](docs/exampleusage.md) documentation.
diff --git a/docs/development.md b/docs/development.md
@@ -0,0 +1,20 @@
+
+
+# Development Pre-requisites
+ * create a virtual environment and loat the python packages with pip
+```
+pip install -r requirements-dev.txt
+```
+ * start a docker archive interface:
+```
+docker run --rm -p 8080:8080 pacifica/archiveinterface
+```
+ * start a redis interface(check this)
+```
+docker run --rm -p 6379:6379 redis
+```
+
+# Run the tests
+```
+coverage run --include 'pacifica/cartd/*' -m pytest -xsv tests/test tests/e2e
+```
diff --git a/requirements.txt b/requirements.txt
@@ -4,6 +4,7 @@ jsonschema
 peewee>2
 psutil
 pymysql
+redis
 requests
 setuptools
 tqdm