Type annotations (#32)

* tidy up * enable type annotations; hide unit test entry point * flake8 * update doc [skip ci]
virgesmith · Mar 19, 2022 · 0e8634e · 0e8634e
1 parent 9c4f3dd
commit 0e8634e
Show file tree

Hide file tree

Showing 14 changed files with 260 additions and 564 deletions.
diff --git a/.travis.yml_disabled b/.travis.yml_disabled
diff --git a/README.md b/README.md
@@ -18,8 +18,6 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/430da36db15f46978bfccd1ad3243ae9)](https://www.codacy.com/gh/virgesmith/humanleague/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=virgesmith/humanleague&amp;utm_campaign=Badge_Grade)
 [![codecov](https://codecov.io/gh/virgesmith/humanleague/branch/main/graph/badge.svg)](https://codecov.io/gh/virgesmith/humanleague)
 
-
-
 ## Introduction
 
 *humanleague* is a python *and* an R package for microsynthesising populations from marginal and (optionally) seed data. The package is implemented in C++ for performance.
@@ -72,8 +70,8 @@ conda install -c conda-forge humanleague
 ### Build, install and test (from cloned repo)
 
 ```bash
-python setup.py install --user
-python setup.py test
+pip install -e .
+pytest
 ```
 
 ### R
@@ -109,12 +107,9 @@ Consult the package documentation, e.g.
 
 ### Python
 
-See [here](doc/api.md), or
+The package now contains type annotations and your IDE should automatically display this, e.g.:
 
-```python
->>> import humanleague as hl
->>> help(hl)
-```
+![help](./doc/help.png)
 
 ### Multidimensional integerisation
 
@@ -163,4 +158,3 @@ array([ True,  True,  True,  True])
 >>> sum(r["result"].T) == sum(a.T)
 array([ True,  True,  True,  True])
 ```
-
diff --git a/appveyor.yml b/appveyor.yml
@@ -1,64 +1,12 @@
 # Build environments
 environment:
   matrix:
-    # - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
-    #   TEST_LANGUAGE: "Python"
-    #   PYTHON: "C:\\Python38-x64"
-    #   PYTHON_ARCH: 64
-    #   MSVC_VERSION: "Visual Studio 19 Win64"
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
-    #   TEST_LANGUAGE: "Python"
-    #   PYTHON: "C:\\Python39-x64"
-    #   PYTHON_ARCH: 64
-    #   MSVC_VERSION: "Visual Studio 19 Win64"
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
-    #   TEST_LANGUAGE: "Python"
-    #   PYTHON: "C:\\Python37-x64"
-    #   PYTHON_ARCH: 64
-    #   MSVC_VERSION: "Visual Studio 19 Win64"
-
     - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
       TEST_LANGUAGE: "R"
       PYTHON: ""
       PYTHON_ARCH: ""
       MSVC_VERSION: ""
 
-    # - APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu
-    #   PYTHON: "3.7"
-    #   APPVEYOR_YML_DISABLE_PS_LINUX: true
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004
-    #   PYTHON: "3.8"
-    #   APPVEYOR_YML_DISABLE_PS_LINUX: true
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004
-    #   PYTHON: "3.9"
-    #   APPVEYOR_YML_DISABLE_PS_LINUX: true
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004
-    #   MINICONDA: true
-    #   PYTHON: "3.9"
-    #   APPVEYOR_YML_DISABLE_PS_LINUX: true
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu
-    #   CODECOV_BUILD: true
-    #   PYTHON: "3.9"
-    #   APPVEYOR_YML_DISABLE_PS_LINUX: true
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: macOS
-    #   PYTHON: "3.7"
-    #   APPVEYOR_YML_DISABLE_PS_LINUX: true
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: macOS
-    #   PYTHON: "3.8"
-    #   APPVEYOR_YML_DISABLE_PS_LINUX: true
-
-    # - APPVEYOR_BUILD_WORKER_IMAGE: macOS
-    #   PYTHON: "3.9"
-    #   APPVEYOR_YML_DISABLE_PS_LINUX: true
-
 stack: python %PYTHON%
 
 # fail fast