Skip to content

Docker #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docker #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c22bfd5
Adding dockerfile
sbassi Apr 5, 2018
6665c04
Adding docker information in the readme
sbassi Apr 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
FROM python:3.6.5-stretch

MAINTAINER Sebastian Bassi

RUN pip install allofplos

RUN python -m allofplos.update
20 changes: 17 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ corpus for further analysis. Use this program to download all PLOS XML
article files instead of doing web scraping.

**NOTE**: This software is not stable, we consider it beta state and will
be in this stage until version 1.0. This means that programming interface
be in this stage until version 1.0. This means that programming interface
may change and after a new version a full corpus download may be required.

Installation instructions
Expand Down Expand Up @@ -102,21 +102,35 @@ To get all of the allofplos testing dependencies run:

``(allofplos)$ pip install -U allofplos[test]``

Then when you run:
Then when you run:

``(allofplos)$ pytest --pyargs allofplos``

It should return something like this:

.. code::

collected 20 items

allofplos/tests/test_corpus.py ............ [ 60%]
allofplos/tests/test_unittests.py ........ [100%]

==================== 20 passed in 0.36 seconds =========================

Docker image
------------

For convenience, we provide a docker image (for Linux and macOS) with the allofplos script plus the whole PLOS corpus pre-downloaded. It can be installed with:

``$ docker pull plos/allofplos``

To use the image, run it like this:

``$ docker run -it plos/allofplos:latest bash``

To generate a new image, use the included Dockerfile:

``$ docker build -t PLOS/allofplos .``

Community guidelines
--------------------
Expand Down