Switch to pipenv

.python-version

@@ -0,0 +1 @@
+3.8.11

.travis.yml

@@ -1,5 +1,7 @@
- language: python
- python:
+language: python
+python:
   - "3.6"
- script:
-  - pytest
+before_script:
+  - pip install pipenv
+script:
+  - pipenv run python -m pytest

Pipfile

@@ -0,0 +1,24 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+allofplos = {editable = true, path = "./"}
+certifi = "*"
+chardet = "*"
+charset-normalizer = "*"
+idna = "*"
+lxml = "*"
+peewee = "*"
+python-utils = "*"
+requests = "*"
+six = "*"
+tqdm = "*"
+unidecode = "*"
+urllib3 = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.8"

README.rst

@@ -23,32 +23,32 @@ may change and after a new version a full corpus download may be required.
 Installation instructions
 -------------------------
 
-This program requires Python 3.4+.
-
-Make a virtual environment:
-
-``$ virtualenv allofplos``
+This program requires Python 3.8+.
 
 Using pip:
 
-``(allofplos)$ pip install allofplos``
+``$ pip install allofplos``
 
 This should install *allofplos* and requirements. At this stage you are ready to go.
 
 If you want to manually install from source (for example for development purposes), first clone the project repository:
 
-``(allofplos)$ git clone [email protected]:PLOS/allofplos.git``
+``$ git clone [email protected]:PLOS/allofplos.git``
 
 Install Python dependencies inside the newly created virtual environment:
 
-``(allofplos)$ pip install -r requirements.txt``
+``$ pipenv install``
 
 How to run the program
 ----------------------
 
 Execute the following command.
 
-``(allofplos)$ python -m allofplos.update``
+``$ python -m allofplos.update``
+
+or, if running from source:
+
+``$ pipenv run python -m allofplos.update``
 
 The first time it runs it will download a >4.4 Gb zip file
 (**allofplos_xml.zip**) with all the XML files inside.
@@ -97,13 +97,7 @@ To run the tests, you will need to install *allofplos* with its testing
 dependencies. These testing dependencies include ``pytest``, which we will use
 to run the tests.
 
-To get all of the *allofplos* testing dependencies run:
-
-``(allofplos)$ pip install -U allofplos[test]``
-
-Then when you run:
-
-``(allofplos)$ pytest --pyargs allofplos``
+``$ pipenv run python -m pytest``
 
 It should return something like this: