Remove Requirements (#60)

This removes the requirements file and puts the dependencies into setup.py so we can use Pip>=20. This also adds documentation testing and updates pre-commit config Signed-off-by: David Brown <dmlb2000@gmail.com>
pacifica · May 15, 2020 · f2fbb70 · f2fbb70
1 parent eb070f4
commit f2fbb70
Show file tree

Hide file tree

Showing 7 changed files with 114 additions and 110 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,10 +1,10 @@
 repos:
 -   repo: https://github.com/pre-commit/mirrors-autopep8
-    rev: v1.5
+    rev: v1.5.2
     hooks:
             -   id: autopep8
--   repo: git://github.com/pre-commit/pre-commit-hooks
-    rev: v2.4.0
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.5.0
     hooks:
             -   id: fix-encoding-pragma
             -   id: trailing-whitespace
@@ -49,7 +49,7 @@ repos:
                 entry: python -m pylint --rcfile=pylintrc
                 language: system
                 types: [python]
--   repo: git://github.com/Lucas-C/pre-commit-hooks
+-   repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.1.7
     hooks:
     -   id: remove-tabs

diff --git a/.travis.yml b/.travis.yml
@@ -2,52 +2,62 @@ dist: bionic
 language: python
 python: 3.6
 stages:
-- lint
-- test
-- deploy
+  - lint
+  - test
+  - test-docs
+  - deploy
 cache: pip
 install:
-- pip install -r requirements-dev.txt
+  - pip install -r requirements-dev.txt
+  - pip install .
 before_script:
-- pip install ansible
-- ansible-galaxy install pacifica.ansible_pacifica pacifica.ansible_travis
-- ansible-playbook ~/.ansible/roles/pacifica.ansible_travis/molecule/common/playbook.yml -i ~/.ansible/roles/pacifica.ansible_travis/molecule/common/inventory.yml -e "ansible_python_interpreter=/home/travis/virtualenv/python${TRAVIS_PYTHON_VERSION}/bin/python travis_virtualenv=python${TRAVIS_PYTHON_VERSION} github_repository=cli"
+  - pip install ansible
+  - ansible-galaxy install pacifica.ansible_pacifica pacifica.ansible_travis
+  - ansible-playbook ~/.ansible/roles/pacifica.ansible_travis/molecule/common/playbook.yml -i ~/.ansible/roles/pacifica.ansible_travis/molecule/common/inventory.yml -e "ansible_python_interpreter=/home/travis/virtualenv/python${TRAVIS_PYTHON_VERSION}/bin/python travis_virtualenv=python${TRAVIS_PYTHON_VERSION} github_repository=cli"
 script:
-- pip install .
-- cd tests
-- coverage run --include='*/site-packages/pacifica/uploader/*' -m pytest -xsv
-- coverage report --show-missing --fail-under 100
+  - cd tests
+  - coverage run --include='*/site-packages/pacifica/uploader/*' -m pytest -xsv
+  - coverage report --show-missing --fail-under 100
 jobs:
   include:
-  - stage: lint
-    before_script: skip
-    script:
-      - pre-commit run -a
-      - radon cc pacifica
-  - python: 3.7
-    before_script: skip
-    script:
-      - pre-commit run -a
-      - radon cc pacifica
-  - python: 3.8
-    before_script: skip
-    script:
-      - pre-commit run -a
-      - radon cc pacifica
-  - stage: test
-  - python: 3.7
-  - python: 3.8
-  - stage: deploy
-    services: []
-    before_script: skip
-    script: skip
-    python: 3.8
-    deploy:
-      skip_cleanup: true
-      provider: pypi
-      user: dmlb2000
-      distributions: sdist bdist_wheel
-      password:
-        secure: iXzIvgJaMdmFT8IJPWNs0XkUi1l2My6kRXmxnT129hrQAiCIHCfJeB898IfFFQM86kwe4p3dA/1t2+IMa4bNqpUZb6Z615MDgWxcpHzn0JMiHMjYHlj9eae/+8IBjSbjoTZPIXRJGZ2NMy5rY8/wkcsXN87J0flhwdUMX8uO5aNDLad8nVYZsU1NeWHKchx07WriFeJaRYo0aCPXRK+kzc2u8eSrOumzKSTaIPnZlknrMJ25BRA8pEhJVlRPMg0Jp+L9ugdwGNtC7o61W5e50XPYC485P0+GwWqgUz2F6NLTzAY0JYNdLgz4XdqdHrpc/lK+TKN2FE9yJq24IFxyyzO7xDPAmhAUiFYnN7URIJyaNcNYGguc668P6Ogs66MVMCLdCQsUMMVb0ok9QqVycYMoZ0h09b2A8tviOnaUVWZbE8Ur0FL3YVADq51L0FWq/Xe1+EnWOlsySyLymh/uNMbL6sHa2dJCkzzwkyFxPTyELWaUC01VQRjyjFJknkX5S0Z+SNiYSQnuFPb4HQKj7hKK4KQ31Yk3hJ2+NDWjvPzviduFHVrxHGRGzd/X1uIPyfubc85YdJn1e7XxjmhMOfxXmzHanlGGKczwatKZe50UqWXQTat2bKnKGeI24jt+ubfznfDqwnF71Lr60+UdD9Xqrqz/KGr9ldE8QbPRcHM=
-      on:
-        tags: true
+    - stage: lint
+      before_script: skip
+      script:
+        - pre-commit run -a
+        - radon cc pacifica
+    - python: 3.7
+      before_script: skip
+      script:
+        - pre-commit run -a
+        - radon cc pacifica
+    - python: 3.8
+      before_script: skip
+      script:
+        - pre-commit run -a
+        - radon cc pacifica
+    - stage: test
+    - python: 3.7
+    - python: 3.8
+    - stage: test-docs
+      python: 3.8
+      before_script: skip
+      script: >
+        cd docs;
+        sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html;
+        sphinx-build -T -b readthedocssinglehtmllocalmedia -d _build/doctrees-readthedocssinglehtmllocalmedia -D language=en . _build/localmedia;
+        sphinx-build -b latex -D language=en -d _build/doctrees . _build/latex;
+        sphinx-build -T -b epub -d _build/doctrees-epub -D language=en . _build/epub
+    - stage: deploy
+      services: []
+      before_script: skip
+      script: skip
+      python: 3.8
+      deploy:
+        skip_cleanup: true
+        provider: pypi
+        user: dmlb2000
+        distributions: sdist bdist_wheel
+        password:
+          secure: iXzIvgJaMdmFT8IJPWNs0XkUi1l2My6kRXmxnT129hrQAiCIHCfJeB898IfFFQM86kwe4p3dA/1t2+IMa4bNqpUZb6Z615MDgWxcpHzn0JMiHMjYHlj9eae/+8IBjSbjoTZPIXRJGZ2NMy5rY8/wkcsXN87J0flhwdUMX8uO5aNDLad8nVYZsU1NeWHKchx07WriFeJaRYo0aCPXRK+kzc2u8eSrOumzKSTaIPnZlknrMJ25BRA8pEhJVlRPMg0Jp+L9ugdwGNtC7o61W5e50XPYC485P0+GwWqgUz2F6NLTzAY0JYNdLgz4XdqdHrpc/lK+TKN2FE9yJq24IFxyyzO7xDPAmhAUiFYnN7URIJyaNcNYGguc668P6Ogs66MVMCLdCQsUMMVb0ok9QqVycYMoZ0h09b2A8tviOnaUVWZbE8Ur0FL3YVADq51L0FWq/Xe1+EnWOlsySyLymh/uNMbL6sHa2dJCkzzwkyFxPTyELWaUC01VQRjyjFJknkX5S0Z+SNiYSQnuFPb4HQKj7hKK4KQ31Yk3hJ2+NDWjvPzviduFHVrxHGRGzd/X1uIPyfubc85YdJn1e7XxjmhMOfxXmzHanlGGKczwatKZe50UqWXQTat2bKnKGeI24jt+ubfznfDqwnF71Lr60+UdD9Xqrqz/KGr9ldE8QbPRcHM=
+        on:
+          tags: true
diff --git a/appveyor.yml b/appveyor.yml
@@ -20,65 +20,66 @@ services:
   - postgresql
 
 before_test:
-- ps: >
-    $env:PATH = "$env:PGSQL_PATH\bin;$env:PATH";
-    createdb pacifica_metadata;
-    createdb pacifica_ingest;
-    mkdir C:\ingest;
-    mkdir C:\archive;
-    C:\pacifica\Scripts\activate.ps1;
-    $env:METADATA_CPCONFIG = "$PWD/travis/metadata/server.conf";
-    pacifica-metadata-cmd dbsync;
-    Start-Process C:\pacifica\Scripts\pacifica-metadata.exe -RedirectStandardError metadata-error.log -RedirectStandardOutput metadata-output.log;
-    nuget install redis-64 -excludeversion;
-    redis-64\tools\redis-server.exe --service-install;
-    redis-64\tools\redis-server.exe --service-start;
-    $env:ARCHIVEINTERFACE_CONFIG = "$PWD/travis/archivei/config.cfg";
-    $env:ARCHIVEINTERFACE_CPCONFIG = "$PWD/travis/archivei/server.conf";
-    Start-Process C:\pacifica\Scripts\pacifica-archiveinterface.exe;
-    $env:UNIQUEID_CONFIG = "$PWD/travis/uniqueid/config.cfg";
-    $env:UNIQUEID_CPCONFIG = "$PWD/travis/uniqueid/server.conf";
-    pacifica-uniqueid-cmd dbsync;
-    Start-Process C:\pacifica\Scripts\pacifica-uniqueid.exe;
-    $env:INGEST_CONFIG = "$PWD/travis/ingest/apconfig.cfg";
-    $env:INGEST_CPCONFIG = "$PWD/travis/ingest/server.conf";
-    pacifica-ingest-cmd dbsync;
-    Start-Process C:\pacifica\Scripts\pacifica-ingest.exe;
-    Start-Process C:\pacifica\Scripts\celery.exe -ArgumentList "-A pacifica.ingest.tasks worker --loglevel=info -P eventlet";
-    $MD_VERSION = `pip show pacifica-metadata | grep Version: | awk '{ print $2 }';
-    Invoke-WebRequest https://github.com/pacifica/pacifica-metadata/archive/v${MD_VERSION}.zip -OutFile pacifica-metadata.zip;
-    Expand-Archive pacifica-metadata.zip -DestinationPath C:\pacifica-metadata;
-    sleep 10; Invoke-WebRequest http://localhost:8121/users;
-    pushd C:\pacifica-metadata\pacifica-metadata-${MD_VERSION};
-    python tests\test_files\loadit_test.py;
-    popd;
-    $env:POLICY_CPCONFIG = "$PWD/travis/policy/server.conf";
-    $env:METADATA_URL = "http://127.0.0.1:8121";
-    $env:STATUS_URL = "http://127.0.0.1:8121/keys?_id=104";
-    Start-Process C:\pacifica\Scripts\pacifica-policy.exe -RedirectStandardError policy-error.log -RedirectStandardOutput policy-output.log;
-    sleep 3;
-    Invoke-WebRequest http://127.0.0.1:8181/status/users/search/dmlb2001/simple -TimeoutSec 1800;
+  - ps: >
+      $env:PATH = "$env:PGSQL_PATH\bin;$env:PATH";
+      createdb pacifica_metadata;
+      createdb pacifica_ingest;
+      mkdir C:\ingest;
+      mkdir C:\archive;
+      C:\pacifica\Scripts\activate.ps1;
+      $env:METADATA_CPCONFIG = "$PWD/travis/metadata/server.conf";
+      pacifica-metadata-cmd dbsync;
+      Start-Process C:\pacifica\Scripts\pacifica-metadata.exe -RedirectStandardError metadata-error.log -RedirectStandardOutput metadata-output.log;
+      nuget install redis-64 -excludeversion;
+      redis-64\tools\redis-server.exe --service-install;
+      redis-64\tools\redis-server.exe --service-start;
+      $env:ARCHIVEINTERFACE_CONFIG = "$PWD/travis/archivei/config.cfg";
+      $env:ARCHIVEINTERFACE_CPCONFIG = "$PWD/travis/archivei/server.conf";
+      Start-Process C:\pacifica\Scripts\pacifica-archiveinterface.exe;
+      $env:UNIQUEID_CONFIG = "$PWD/travis/uniqueid/config.cfg";
+      $env:UNIQUEID_CPCONFIG = "$PWD/travis/uniqueid/server.conf";
+      pacifica-uniqueid-cmd dbsync;
+      Start-Process C:\pacifica\Scripts\pacifica-uniqueid.exe;
+      $env:INGEST_CONFIG = "$PWD/travis/ingest/apconfig.cfg";
+      $env:INGEST_CPCONFIG = "$PWD/travis/ingest/server.conf";
+      pacifica-ingest-cmd dbsync;
+      Start-Process C:\pacifica\Scripts\pacifica-ingest.exe;
+      Start-Process C:\pacifica\Scripts\celery.exe -ArgumentList "-A pacifica.ingest.tasks worker --loglevel=info -P eventlet";
+      $MD_VERSION = `pip show pacifica-metadata | grep Version: | awk '{ print $2 }';
+      Invoke-WebRequest https://github.com/pacifica/pacifica-metadata/archive/v${MD_VERSION}.zip -OutFile pacifica-metadata.zip;
+      Expand-Archive pacifica-metadata.zip -DestinationPath C:\pacifica-metadata;
+      sleep 10; Invoke-WebRequest http://localhost:8121/users;
+      pushd C:\pacifica-metadata\pacifica-metadata-${MD_VERSION};
+      python tests\test_files\loadit_test.py;
+      popd;
+      $env:POLICY_CPCONFIG = "$PWD/travis/policy/server.conf";
+      $env:METADATA_URL = "http://127.0.0.1:8121";
+      $env:STATUS_URL = "http://127.0.0.1:8121/keys?_id=104";
+      Start-Process C:\pacifica\Scripts\pacifica-policy.exe -RedirectStandardError policy-error.log -RedirectStandardOutput policy-output.log;
+      sleep 3;
+      Invoke-WebRequest http://127.0.0.1:8181/status/users/search/dmlb2001/simple -TimeoutSec 1800;
 
 build: off
 
 install:
-    - ps: >
-        $env:PATH = "$env:MYSQL_PATH\bin;${env:PGSQL_PATH}\bin;${env:PYTHON}\Scripts;${env:PATH}";
-        Invoke-WebRequest -Uri "https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.6.5.zip" -OutFile "elasticsearch.zip";
-        Expand-Archive "elasticsearch.zip" -DestinationPath "C:\elasticsearch";
-        Start-Process C:\elasticsearch\elasticsearch-5.6.5\bin\elasticsearch;
-        & $env:PYTHON\python.exe -m virtualenv C:\pacifica;
-        C:\pacifica\Scripts\activate.ps1;
-        python -m pip install pip setuptools wheel --upgrade;
-        pip install -r requirements-dev.txt;
-        pip install celery[redis] eventlet redis;
-        echo 'Done';
+  - ps: >
+      $env:PATH = "$env:MYSQL_PATH\bin;${env:PGSQL_PATH}\bin;${env:PYTHON}\Scripts;${env:PATH}";
+      Invoke-WebRequest -Uri "https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.6.5.zip" -OutFile "elasticsearch.zip";
+      Expand-Archive "elasticsearch.zip" -DestinationPath "C:\elasticsearch";
+      Start-Process C:\elasticsearch\elasticsearch-5.6.5\bin\elasticsearch;
+      & $env:PYTHON\python.exe -m virtualenv C:\pacifica;
+      C:\pacifica\Scripts\activate.ps1;
+      python -m pip install pip setuptools wheel --upgrade;
+      pip install -r requirements-dev.txt;
+      pip install .;
+      pip install celery[redis] eventlet redis;
+      echo 'Done';
 
 
 test_script:
   - ps: >
       C:\pacifica\Scripts\activate.ps1;
-      pip install .;
+      pre-commit run -a;
       cd tests;
       coverage run --include="*/site-packages/pacifica/uploader/*" -m pytest -v;
       coverage report --show-missing --fail-under 100;
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,6 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('..'))
-from recommonmark.parser import CommonMarkParser
 
 # -- Project information -----------------------------------------------------
 
@@ -45,6 +44,8 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'readthedocs_ext.readthedocs',
+    'recommonmark'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -53,9 +54,6 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_parsers = {
-    '.md': CommonMarkParser,
-}
 source_suffix = ['.rst', '.md']
 
 # The master toctree document.

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,4 +1,3 @@
--r requirements.txt
 coverage
 pacifica-archiveinterface
 pacifica-ingest
@@ -10,4 +9,7 @@ pre-commit
 pylint
 pytest
 radon
+readthedocs-sphinx-ext
 recommonmark
+sphinx
+sphinx-rtd-theme
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.py b/setup.py
@@ -2,14 +2,8 @@
 # -*- coding: utf-8 -*-
 """Setup and install the metadata."""
 from os import path
-try:  # pip version 9
-    from pip.req import parse_requirements
-except ImportError:
-    from pip._internal.req import parse_requirements
 from setuptools import setup, find_packages
 
-# parse_requirements() returns generator of pip.req.InstallRequirement objects
-INSTALL_REQS = parse_requirements('requirements.txt', session='hack')
 
 setup(
     name='pacifica-uploader',
@@ -25,5 +19,5 @@
     author_email='david.brown@pnnl.gov',
     packages=find_packages(include=['pacifica.*']),
     namespace_packages=['pacifica'],
-    install_requires=[str(ir.req) for ir in INSTALL_REQS]
+    install_requires=['requests']
 )