chore: clean up tox, pre-commit and requirements

nejch · JohnVillalovos · commit 237b97ceb061 · 2021-05-29T20:36:57.000-07:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -40,6 +40,4 @@ jobs:
       - name: Check twine readme rendering
         env:
           TOXENV: twine-check
-        run: |
-          python3 setup.py sdist bdist_wheel
-          tox
+        run: tox
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -6,17 +6,13 @@ repos:
     rev: 20.8b1
     hooks:
       - id: black
-
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
     rev: v5.0.0
     hooks:
       - id: commitlint
         additional_dependencies: ['@commitlint/config-conventional']
         stages: [commit-msg]
-
-  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v5.0.0
+  - repo: https://github.com/pycqa/isort
+    rev: 5.8.0
     hooks:
-      - id: commitlint-travis
-        additional_dependencies: ['@commitlint/config-conventional']
-        stages: [manual]
+      - id: isort
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -10,4 +10,4 @@ formats:
 python:
   version: 3.8
   install:
-    - requirements: rtd-requirements.txt
+    - requirements: requirements-docs.txt
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,4 @@
-include COPYING AUTHORS ChangeLog.rst RELEASE_NOTES.rst requirements.txt test-requirements.txt rtd-requirements.txt
-include tox.ini .travis.yml
+include COPYING AUTHORS ChangeLog.rst RELEASE_NOTES.rst requirements*.txt
+include tox.ini
 recursive-include tests *
 recursive-include docs *j2 *.py *.rst api/*.rst Makefile make.bat
-recursive-include tests/unit/data *
diff --git a/README.rst b/README.rst
@@ -144,21 +144,22 @@ To format your code according to our guidelines before committing, run:
 Running unit tests
 ------------------
 
-Before submitting a pull request make sure that the tests still succeed with
-your change. Unit tests and functional tests run using the travis service and
-passing tests are mandatory to get merge requests accepted.
+Before submitting a pull request make sure that the tests and lint checks still succeed with
+your change. Unit tests and functional tests run in GitHub Actions and
+passing checks are mandatory to get merge requests accepted.
 
-We're currently in a restructing phase for the unit tests. If you're changing existing
-tests, feel free to keep the current format. Otherwise please write new tests with pytest and
-using `responses
+Please write new unit tests with pytest and using `responses
 <https://github.com/getsentry/responses/>`_.
-An example for new tests can be found in tests/objects/test_runner.py
+An example can be found in ``tests/unit/objects/test_runner.py``
 
-You need to install ``tox`` to run unit tests and documentation builds locally:
+You need to install ``tox`` (``pip3 install tox``) to run tests and lint checks locally:
 
 .. code-block:: bash
 
-   # run the unit tests for all supported python3 versions, and the pep8 tests:
+   # run unit tests using your installed python3, and all lint checks:
+   tox -s
+
+   # run unit tests for all supported python3 versions, and all lint checks:
    tox
 
    # run tests in one environment only:
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,8 @@
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+order_by_type = false
+
 [tool.semantic_release]
 version_variable = "gitlab/__version__.py:__version__"
 commit_subject = "chore: release v{version}"
diff --git a/requirements-docker.txt b/requirements-docker.txt
@@ -1,5 +1,5 @@
 -r requirements.txt
--r test-requirements.txt
+-r requirements-test.txt
 docker-compose==1.29.2 # prevent inconsistent .env behavior from system install
 pytest-console-scripts
 pytest-docker
diff --git a/requirements-docs.txt b/requirements-docs.txt
diff --git a/requirements-lint.txt b/requirements-lint.txt
@@ -0,0 +1,4 @@
+black
+flake8
+isort
+mypy
diff --git a/requirements-test.txt b/requirements-test.txt
@@ -1,7 +1,6 @@
 coverage
 httmock
 mock
-mypy
 pytest
 pytest-cov
 responses
diff --git a/tox.ini b/tox.ini
@@ -11,48 +11,45 @@ usedevelop = True
 install_command = pip install {opts} {packages}
 
 deps = -r{toxinidir}/requirements.txt
-       -r{toxinidir}/test-requirements.txt
+       -r{toxinidir}/requirements-test.txt
 commands =
   pytest tests/unit {posargs}
 
 [testenv:pep8]
 basepython = python3
-deps = -r{toxinidir}/requirements.txt
-       -r{toxinidir}/test-requirements.txt
-       flake8
+envdir={toxworkdir}/lint
+deps = -r{toxinidir}/requirements-lint.txt
 commands =
   flake8 {posargs} .
 
 [testenv:black]
 basepython = python3
-deps = -r{toxinidir}/requirements.txt
-       -r{toxinidir}/test-requirements.txt
-       black
+envdir={toxworkdir}/lint
+deps = -r{toxinidir}/requirements-lint.txt
 commands =
   black {posargs} .
 
 [testenv:isort]
 basepython = python3
-deps = -r{toxinidir}/requirements.txt
-       -r{toxinidir}/test-requirements.txt
-       isort
+envdir={toxworkdir}/lint
+deps = -r{toxinidir}/requirements-lint.txt
 commands =
-  isort --dont-order-by-type {posargs} {toxinidir}
+  isort {posargs} {toxinidir}
 
-[testenv:twine-check]
+[testenv:mypy]
 basepython = python3
-deps = -r{toxinidir}/requirements.txt
-       -r{toxinidir}/test-requirements.txt
-       twine
+envdir={toxworkdir}/lint
+deps = -r{toxinidir}/requirements-lint.txt
 commands =
-  twine check dist/*
+  mypy {posargs}
 
-[testenv:mypy]
+[testenv:twine-check]
 basepython = python3
 deps = -r{toxinidir}/requirements.txt
-       -r{toxinidir}/test-requirements.txt
+       twine
 commands =
-  mypy {posargs}
+  python3 setup.py sdist bdist_wheel
+  twine check dist/*
 
 [testenv:venv]
 commands = {posargs}
@@ -68,12 +65,8 @@ ignore = E203,E501,W503
 per-file-ignores =
     gitlab/v4/objects/__init__.py:F401,F403
 
-[isort]
-profile = black
-multi_line_output = 3
-
 [testenv:docs]
-deps = -r{toxinidir}/rtd-requirements.txt
+deps = -r{toxinidir}/requirements-docs.txt
 commands = python setup.py build_sphinx
 
 [testenv:cover]
@@ -95,11 +88,11 @@ exclude_lines =
 script_launch_mode = subprocess
 
 [testenv:cli_func_v4]
-deps = -r{toxinidir}/docker-requirements.txt
+deps = -r{toxinidir}/requirements-docker.txt
 commands =
   pytest --cov --cov-report xml tests/functional/cli {posargs}
 
 [testenv:py_func_v4]
-deps = -r{toxinidir}/docker-requirements.txt
+deps = -r{toxinidir}/requirements-docker.txt
 commands =
   pytest --cov --cov-report xml tests/functional/api {posargs}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +black
 +flake8
 +isort
 +mypy