Drop Pipenv dependency

mirekdlugosz · Oct 2, 2019 · 02e8434 · 02e8434
1 parent 8815ac3
commit 02e8434
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 190 deletions.
diff --git a/backend/Pipfile b/backend/Pipfile
diff --git a/backend/Pipfile.lock b/backend/Pipfile.lock
diff --git a/backend/README.md b/backend/README.md
@@ -6,21 +6,29 @@ Flask application that provides data through REST service.
 
 * Python 3.4 or later
 * [Flask](http://flask.pocoo.org/)
-* json module (should come with Python)
-* [pipenv](https://github.com/pypa/pipenv) for installation
-* JSON files created by data-reader component
+* JSON files created by `data-reader` component
 
 ## Installation
 
-Run following command:
+Create new virtual environment and install dependencies from requirements.txt file in root of repository:
 
 ```
-pipenv install --dev
+$ python3 -m venv /path/to/venv
+$ . /path/to/venv/bin/activate
+$ pip install -r ../requirements.txt
 ```
 
+Then, use `pokedexreader` command to create JSON data files:
+
+```
+$ pokedexreader <options> -o backend/api/data/
+```
+
+You can - and should! - use one virtual environment for both `backend` and `data-manager`.
+
 ## Usage
 
-When running in virtualenv shell (`pipenv shell`), run:
+When virtual environment for this project is active, run:
 
 ```
 ./run.py
@@ -30,7 +38,7 @@ REST service will be available at `http://127.0.0.1:8861/`.
 
 ## Running tests
 
-When running in virtualenv shell (`pipenv shell`), run:
+When virtual environment for this project is active, run:
 
 ```
 pytest

diff --git a/data-manager/Pipfile b/data-manager/Pipfile
diff --git a/data-manager/Pipfile.lock b/data-manager/Pipfile.lock
diff --git a/data-manager/README.md b/data-manager/README.md
@@ -5,21 +5,23 @@ data-manager takes data from specified source and outputs JSON files readable by
 ## Requirements
 
 * Python 3.4 or later
-* sqlite3 and json modules (should come with Python)
-* [pipenv](https://github.com/pypa/pipenv) for installation
 * SQLite file with data from [veekun Pokédex](https://github.com/veekun/pokedex)
 
 ## Installation
 
-Run following command:
+Create new virtual environment and install dependencies from requirements.txt file in root of repository:
 
 ```
-pipenv install --dev
+$ python3 -m venv /path/to/venv
+$ . /path/to/venv/bin/activate
+$ pip install -r ../requirements.txt
 ```
 
+You can - and should! - use one virtual environment for both `backend` and `data-manager`.
+
 ## Setting up data source
 
-This component requires some data source. Currently only SQLite file with veekun Pokédex is supported. You can acquire it by running following commands:
+This component requires some data source. Currently only SQLite file with veekun Pokédex is supported. You can acquire it by running following commands; make sure to run them outside of **this** project repository:
 
 ```
 git clone https://github.com/veekun/pokedex.git
@@ -34,7 +36,7 @@ Path to SQLite file will be printed out at the beginning of output. Or you can u
 
 ## Usage
 
-When running in virtualenv shell (`pipenv shell`), run:
+When virtual environment for this project is active, run:
 
 ```
 pokedexreader --eevee <path_to_veekun_pokedex.sqlite> -o <path_to_backend/api/data/>

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,6 @@
+flask
+
+--editable data-manager/
+--editable backend/
+
+pytest