From c1c2e319ac34366b5f430b47ed5a3615e35797fc Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Mon, 12 Nov 2018 08:49:02 +0200 Subject: [PATCH] README.md: Rework to use pip instead of pipenv Pipenv is great for local development, but I don't think many people are using it yet. I can use it locally and on Travis, but still keep vanilla requirements.txt for use with pip. The requirements.txt file can be generated easily from pipenv itself: $ pipenv lock -r > requirements.txt The same for the development requirements: $ pipenv lock -r -d > requirements-dev.txt --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1b6ec13..6bef2c1 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,14 @@ This project contains an indexer and a [Falcon-based](https://falcon.readthedocs - PostgreSQL version 9.5+ (due to [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT)) - DSpace with [Solr usage statistics enabled](https://wiki.duraspace.org/display/DSDOC5x/SOLR+Statistics) (tested with 5.x) -## Installation and Testing -Create a Python virtual environment and install the dependencies using [`pipenv`](https://github.com/pypa/pipenv): +## Installation +Create a Python virtual environment and install the dependencies: - $ pipenv install --dev - $ pipenv shell + $ python3 -m venv venv + $ source venv/bin/activate + $ pip install -r requirements.txt + +## Running Set up the environment variables for Solr and PostgreSQL: @@ -35,6 +38,11 @@ Test to see if there are any statistics: $ curl 'http://localhost:8000/items?limit=1' +## Testing +Install development packages using pip: + + $ pip install -r requirements-dev.txt + Run tests: $ pytest