Merge pull request #335 from bashtage/doc-update

Doc update

.pep8speaks.yml

@@ -0,0 +1,11 @@
+scanner:
+    diff_only: False
+    linter: flake8  # Other option is flake8
+
+pycodestyle:  # Same as scanner.linter value. Other option is flake8
+    max-line-length: 99  # Default is 79 in PEP 8
+    ignore:  # Errors and warnings to ignore
+        - E203  # Whitespace before ':'
+        - W503  # Line break occurred before a binary operator (W503)
+
+no_blank_comment: False  # If True, no comment is made on PR without any errors.

.travis.yml

@@ -82,7 +82,7 @@ before_install:
   - echo conda create --yes --quiet -n arch-test ${PKGS}
   - conda create --yes --quiet -n arch-test ${PKGS}
   - source activate arch-test
-  - pip install property_cached flake8 pytest pytest-xdist!=1.30 pytest-cov "coverage<5" coveralls codecov nbformat nbconvert!=5.4 jupyter_client ipython jupyter -q
+  - pip install property_cached flake8 pytest pytest-xdist!=1.30 pytest-cov "coverage<5" codacy-coverage coveralls codecov nbformat nbconvert!=5.4 jupyter_client ipython jupyter -q
   - if [[ "$STATSMODELS_MASTER" == true ]]; then sh ./ci/statsmodels-master.sh; fi;
   - |
     if [[ "$DOCBUILD" == true ]]; then
@@ -95,12 +95,12 @@ before_install:
   - conda list
   - export PYTHONHASHSEED=0
   - export MKL_NUM_THREADS=1
-  - if [[ "$COVERAGE" == true ]]; then export COVERAGE_OPTS="--cov-config .coveragerc --cov=arch"; fi
+  - if [[ "$COVERAGE" == true ]]; then export COVERAGE_OPTS="--cov-config .coveragerc --cov=arch --cov-report xml:coverage.xml --cov-report term"; fi
 
 install:
   - |
     if [[ "$COVERAGE" == true ]]; then
-      python setup.py develop
+      pip install -e .
     else
       pip install .
     fi
@@ -132,4 +132,9 @@ script:
   - flake8 arch
 
 after_success:
-  - if [[ "$COVERAGE" = true ]]; then codecov; coveralls --rcfile="$SRCDIR"/.coveragerc; fi
+  - |
+    if [[ "$COVERAGE" = true ]]; then
+      codecov
+      coveralls --rcfile="$SRCDIR"/.coveragerc
+      python-codacy-coverage -r coverage.xml
+    fi

README.md

@@ -23,11 +23,11 @@ to improve performance)
 ###### Code Inspections
 [![Code Quality: Python](https://img.shields.io/lgtm/grade/python/g/bashtage/arch.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bashtage/arch/context:python)
 [![Total Alerts](https://img.shields.io/lgtm/alerts/g/bashtage/arch.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/bashtage/arch/alerts)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cea43b588e0f4f2a9d8ba37cf63f8210)](https://www.codacy.com/app/bashtage/arch?utm_source=github.com&utm_medium=referral&utm_content=bashtage/arch&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/93f6fd90209842bf97fd20fda8db70ef)](https://www.codacy.com/manual/bashtage/arch?utm_source=github.com&utm_medium=referral&utm_content=bashtage/arch&utm_campaign=Badge_Grade)
 [![codebeat badge](https://codebeat.co/badges/18a78c15-d74b-4820-b56d-72f7e4087532)](https://codebeat.co/projects/github-com-bashtage-arch-master)
 
 ###### Citation
-[![DOI](https://zenodo.org/badge/23468876.svg)](https://zenodo.org/badge/latestdoi/23468876)
+[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.3551028.svg)](https://doi.org/10.5281/zenodo.3551028)
 
 ## Module Contents
 
@@ -174,7 +174,7 @@ that arch will work with older versions.
 
 * Python (3.6+)
 * NumPy (1.14+)
-* SciPy (1+)
+* SciPy (1.0.1+)
 * Pandas (0.23+)
 * statsmodels (0.9+)
 * matplotlib (2.0+), optional

README.rst

@@ -199,7 +199,7 @@ arch will work with older versions.
 
 -  Python (3.6+)
 -  NumPy (1.14+)
--  SciPy (1+)
+-  SciPy (1.0.1+)
 -  Pandas (0.23+)
 -  statsmodels (0.9+)
 -  matplotlib (2.0+), optional
@@ -302,5 +302,5 @@ Installation Notes:
    :target: https://www.codacy.com/app/bashtage/arch?utm_source=github.com&utm_medium=referral&utm_content=bashtage/arch&utm_campaign=Badge_Grade
 .. |codebeat badge| image:: https://codebeat.co/badges/18a78c15-d74b-4820-b56d-72f7e4087532
    :target: https://codebeat.co/projects/github-com-bashtage-arch-master
-.. |DOI| image:: https://zenodo.org/badge/23468876.svg
-   :target: https://zenodo.org/badge/latestdoi/23468876
+.. |DOI| image:: https://zenodo.org/badge/doi/10.5281/zenodo.3551028.svg
+   :target: https://doi.org/10.5281/zenodo.3551028

appveyor.yml

@@ -26,7 +26,7 @@ build_script:
   - cmd: conda install numpy cython pytest pandas scipy patsy statsmodels matplotlib numba nbconvert nbformat pip pyyaml setuptools pyqt pyparsing --quiet
   - cmd: python -m pip install --upgrade pip
   - cmd: pip install pytest-xdist!=1.30 property_cached
-  - cmd: python setup.py develop
+  - cmd: pip install -e .
 
 test_script:
-  - cmd: py.test -n 2 arch -m "(not slow)" --durations=25
+  - cmd: pytest -n 2 arch -m "(not slow)" --durations=25

arch/__init__.py

@@ -2,13 +2,14 @@
 from arch.univariate.mean import arch_model
 from arch.utility import test
 
-__version__ = get_versions()['version']
+__version__ = get_versions()["version"]
 del get_versions
 
 
 def doc():
     import webbrowser
-    webbrowser.open('http://arch.readthedocs.org/en/latest/')
 
+    webbrowser.open("http://arch.readthedocs.org/en/latest/")
 
-__all__ = ['arch_model', '__version__', 'doc', 'test']
+
+__all__ = ["arch_model", "__version__", "doc", "test"]