Merge pull request #469 from uqfoundation/pep517

enable support for develop and pep517

.codecov.yml

@@ -20,3 +20,9 @@ coverage:
         target: auto
         threshold: 1%
 
+fixes:
+  # reduces pip-installed path to git root and
+  # remove dist-name from setup-installed path
+  - "*/site-packages/::"
+  - "*/site-packages/dill-*::"
+

.coveragerc

@@ -1,6 +1,7 @@
 [run]
 # source = dill
-include = */dill/*
+include =
+    */dill/*
 omit = 
     */tests/*
     */info.py
@@ -11,7 +12,15 @@ branch = true
 # data_file = $TRAVIS_BUILD_DIR/.coverage
 # debug = trace
 
+[paths]
+source =
+    dill
+    */site-packages/dill
+    */site-packages/dill-*/dill
+
 [report]
+include =
+    */dill/*
 exclude_lines =
     pragma: no cover
     raise NotImplementedError

.readthedocs.yml

@@ -8,7 +8,7 @@ sphinx:
 
 # build
 python:
-  version: "3.7"
+  version: "3.9"
   install:
     - method: pip
       path: .

.travis.yml

@@ -10,14 +10,14 @@ matrix:
 
         - python: '3.7'
           env:
-            - COVERAGE="true"
-            - NUMPY="true"
 
         - python: '3.8'
           env:
 
         - python: '3.9'
           env:
+            - COVERAGE="true"
+            - NUMPY="true"
 
         - python: '3.10'
           env:
@@ -48,11 +48,12 @@ before_install:
     - if [[ $NUMPY == "true" ]]; then pip install numpy; fi
 
 install:
-    - python setup.py build && python setup.py install
+    - python -m pip install .
 
 script:
     - for test in tests/__init__.py; do echo $test ; if [[ $COVERAGE == "true" ]]; then coverage run -a $test > /dev/null; else python $test > /dev/null; fi ; done
     - for test in tests/test_*.py; do echo $test ; if [[ $COVERAGE == "true" ]]; then coverage run -a $test > /dev/null; else python $test > /dev/null; fi ; done
 
 after_success:
     - if [[ $COVERAGE == "true" ]]; then bash <(curl -s https://codecov.io/bash); else echo ''; fi
+    - if [[ $COVERAGE == "true" ]]; then coverage report; fi

MANIFEST.in

@@ -1,5 +1,7 @@
 include LICENSE
 include README*
+include MANIFEST.in
+include pyproject.toml
 include tox.ini
 include scripts/*
 include tests/*py

README.md

@@ -83,6 +83,35 @@ You can get the latest development version with all the shiny new features at:
 If you have a new contribution, please submit a pull request.
 
 
+Installation
+------------
+``dill`` can be installed with ``pip``::
+
+    $ pip install dill
+
+To optionally include the ``objgraph`` diagnostic tool in the install::
+
+    $ pip install dill[graph]
+
+For windows users, to optionally install session history tools::
+
+    $ pip install dill[readline]
+
+
+Requirements
+------------
+``dill`` requires:
+
+* ``python`` (or ``pypy``), **==2.7** or **>=3.7**
+* ``setuptools``, **>=42**
+* ``wheel``, **>=0.1**
+
+Optional requirements:
+
+* ``objgraph``, **>=1.7.2**
+* ``pyreadline``, **>=1.7.1** (on windows)
+
+
 Basic Usage
 -----------
 ``dill`` is a drop-in replacement for ``pickle``. Existing code can be