Merge pull request #75 from cmc333333/django1011

Proclaim support, add tests for Django 1.10 and 1.11

.dockerignore

@@ -1,8 +1,8 @@
+*.py[co]
 *.swp
-*.pyc
+eregs.db
+regcore.egg-info/
 .coverage
-local_settings.py
-
-docs/_build
-
-*.egg-info/
+.tox
+# local_settings.py
+docs/_build/

.gitignore

@@ -5,3 +5,4 @@ regcore.egg-info/
 .coverage
 .tox
 local_settings.py
+docs/_build/

.travis.yml

@@ -1,19 +1,14 @@
 language: python
 sudo: false
 python:
-    - "2.7"
-    - "3.4"
-    - "3.5"
-    - "pypy"
-    # - "3.2" pyelasticsearch is not compatible
-    # - "3.3" Django stopped supporting this in 1.9
-    # - "pypy3" requires sudo in travis
+  - "2.7"
+  - "3.4"
+  - "3.5"
+  - "3.6"
+  - "pypy"
 install:
-    - pip install -r requirements.txt
-    - pip install -r requirements_test.txt
+  - pip install coveralls tox-travis
 script:
-  - pytest --cov
-  - flake8 .
-  - bandit -r . -x regcore/tests,regcore_read/tests,regcore_write/tests
+  - tox
 after_success:
-  - if [[ $INTEGRATION_TARGET = '' ]] && [[ $TRAVIS_PYTHON_VERSION = '3.5' ]]; then coveralls; fi
+  - if [[ $INTEGRATION_TARGET = '' ]] && [[ $TRAVIS_PYTHON_VERSION = '3.6' ]]; then coveralls; fi

Dockerfile

@@ -3,7 +3,11 @@ FROM python:3-alpine
 COPY [".", "/app/src/"]
 
 WORKDIR /app/src/
-RUN pip install --no-cache-dir -r requirements.txt \
+RUN apk --update add ca-certificates \
+    && update-ca-certificates \
+    && rm -rf /var/cache/apk/*
+RUN pip install --no-cache-dir --upgrade pip \
+    && pip install --no-cache-dir -e .[all-backends] \
     && python manage.py migrate
 
 ENV PYTHONUNBUFFERED="1"

README.md

@@ -6,7 +6,7 @@ regulations-core
 [![Code Climate](https://codeclimate.com/github/eregs/regulations-core/badges/gpa.svg)](https://codeclimate.com/github/eregs/regulations-core)
 [![Code Issues](https://www.quantifiedcode.com/api/v1/project/0cdc7eb543724f60b428aa9cae42bd5f/badge.svg)](https://www.quantifiedcode.com/app/project/0cdc7eb543724f60b428aa9cae42bd5f)
 
-An API that provides an interface for storing and retrieving regulations,
+An API library that provides an interface for storing and retrieving regulations,
 layers, etc.
 
 This repository is part of a larger project. To read about it, please see
@@ -23,76 +23,66 @@ This repository is part of a larger project. To read about it, please see
 
 ## Requirements
 
-This application requires Python 2.7 (including PyPy), 3.3, 3.4, 3.5
+This library requires
+* Python 2.7 (including PyPy), 3.4, 3.5, or 3.6
+* Django 1.8, 1.9, 1.10, or 1.11
 
-Requirements are retrieved and/or build automatically via pip (see below).
+## API Docs
 
-* django - Web framework
-* jsonschema - used to test that JSON provided fits our required data
-  structure
+[regulations-core on Read The Docs](http://regulations-core.readthedocs.org/en/latest/)
 
-The following libraries are optionally supported
+## Local development
 
-* coverage - reports on test coverage
-* django-haystack - An interface for accessing Solr, Whoosh, and other search
-  engines. This is only required if not using Elastic Search. Unfortunately,
-  we are constrained to using the pre-rewrite version of haystack (though
-  that may change in the future)
-* py.test - provides py.test as a test runner
-* mock - makes constructing mock objects/functions easy
-* pyelasticsearch - required if using Elastic Search
-* flake8 - while not strictly required, we try to meet its standards
-* pysolr - required if using solr as a search backend
+### Tox
 
-## API Docs
-
-[regulations-core on Read The Docs](http://regulations-core.readthedocs.org/en/latest/)
+We use [tox](tox.readthedocs.io) to test across multiple versions of Python
+and Django. To run our tests, linters, and build our docs, you'll need to
+install `tox` *globally* (Tox handles virtualenvs for us).
 
-## Setup & Running
+```bash
+pip install tox
+# If using pyenv, consider also installing tox-pyenv
+```
 
-### Docker
+Then, run tests and linting across available Python versions:
 
-For quick installation, consider installing from our
-[Docker Image](https://hub.docker.com/r/eregs/core/). This image includes all
-of the relevant dependencies, wrapped up in a "container" for ease of
-installation. To run it, you'll need to have Docker installed, though the
-installation instructions for [Linux](https://docs.docker.com/linux/step_one/),
-[Mac](https://docs.docker.com/mac/step_one/), and
-[Windows](https://docs.docker.com/windows/step_one/) are relatively painless.
+```bash
+tox
+```
 
-The image is tailored for development purposes; it runs in DEBUG mode using
-SQLite for data storage. To start it up, you'll want to run it in daemon mode,
-forwarding port 8080:
+To build docs, run:
 
 ```bash
-docker run -p 8080:8080 -d eregs/core
+tox -e docs
 ```
 
-Your server should now be running at http://localhost:8080/. Use docker
-commands such as `docker ps`, `docker kill`, and `docker rm` to stop the
-service. Note, however, that the database will disappear with the service.
+The output will be in `docs/_build/dirhtml`.
 
-### From Source
+### Running as an application
 
-This project uses `requirements*.txt` files for defining dependencies, so you
-can get up and running with `pip`:
+While this library is generally intended to be used within a larger project,
+it can also be ran as its own application via
+[Docker](https://www.docker.com/) or a local Python install. In both cases,
+we'll run in `DEBUG` mode using SQLite for data storage. We don't have a turn
+key solution for integrating this with search (though it can be accomplished
+via a custom settings file).
 
+To run via Docker, 
 ```bash
-$ pip install -r requirements.txt       # modules required for execution
-$ pip install -r requirements_test.txt  # modules required for running tests
-$ pip install -r requirements_dev.txt   # helpful modules for developers
+docker build . -t eregs/core  # only needed after code changes
+docker run -p 8080:8080 eregs/core
 ```
 
-With that, you just need a few additional commands to get up and running:
+To run via local Python, run the following inside a
+[virtualenv](https://virtualenv.pypa.io/en/stable/):
 ```bash
-$ python manage.py migrate --fake-initial
-$ python manage.py runserver
+pip install .
+python manage.py migrate
+python manage.py runserver 0.0.0.0:8080
 ```
 
-You'll be running (without search capability) using SQLite.
-
-By default, you'll be using the settings defined in `regcore/settings/base.py`.
-We recommend local modification be made in a `local_settings.py` file.
+In both cases, you can find the site locally at
+[http://0.0.0.0:8080/](http://0.0.0.0:8080/).
 
 ## Apps included
 
@@ -189,27 +179,6 @@ All standard Django and haystack settings are also available; you will likely
 want to override `DATABASES`, `HAYSTACK_CONNECTIONS`, `DEBUG` and certainly
 `SECRET_KEY`.
 
-## Building the documentation
-
-For most tweaks, you will simply need to run the Sphinx documentation
-builder again.
-
-```bash
-$ sphinx-build -b dirhtml -d docs/_build/doctrees/ docs/ docs/_build/dirhtml/
-```
-
-The output will be in `docs/_build/dirhtml`.
-
-If you are adding new modules, you may need to re-run the skeleton build
-script first:
-
-```bash
-$ rm docs/regcore*.rst
-$ sphinx-apidoc -F -o docs regcore
-$ sphinx-apidoc -F -o docs regcore_read
-$ sphinx-apidoc -F -o docs regcore_write
-```
-
 ##  Importing Data
 
 ### Via the `eregs` parser
@@ -258,22 +227,3 @@ do \
     curl -X PUT http://localhost:8000/$TAIL -d @$TAIL \
 done
 ```
-
-##  Running Tests
-
-```bash
-$ python manage.py test
-```
-
-This will include a report of test coverage.
-
-To run tests across all supported python versions, run `tox`.
-
-## Linting
-
-We rely on flake8 for linting and style checks. You can run it over everything
-via
-
-```bash
-$ flake8 .
-```