set up workflow to mirror modern projects

Author: rgbkrk

.github/workflows/ci.yaml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python_version: ["3.8", "3.9", "3.10"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup nox
+        uses: daisylb/[email protected]
+      - name: Setup poetry
+        uses: Gr1N/setup-poetry@v7
+      - name: Install dependencies
+        run: |
+          poetry install --all-extras --with dev
+          pip install nox-poetry
+      - name: Run tests
+        run: nox -s test-${{ matrix.python_version }}
+      - name: Generate coverage XML
+        run: nox -s generate_coverage_xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+  lint:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup nox
+        uses: daisylb/[email protected]
+      - name: Setup poetry
+        uses: Gr1N/setup-poetry@v7
+      - name: Install dependencies
+        run: |
+          poetry install --all-extras --with dev
+          pip install nox-poetry
+      - name: Run lint
+        run: nox -s lint
+      - name: Type checking
+        run: |
+          poetry run mypy vdom/

.travis.yml

@@ -0,0 +1,56 @@
+import nox
+import nox_poetry
+
+LINT_PATHS = ["vdom", "noxfile.py"]
+
+nox.options.reuse_existing_virtualenv = True
+nox.options.sessions = ["lint", "test"]
+
+
+@nox_poetry.session(python=["3.8", "3.9", "3.10"])
+def test(session: nox_poetry.Session):
+    session.run_always("poetry", "install", external=True)
+    session.run("pytest", "-v", "--cov=vdom")
+
+
+@nox_poetry.session(python="3.9")
+def generate_coverage_xml(session: nox_poetry.Session):
+    session.install("coverage[toml]")
+    session.run("coverage", "xml")
+
+
+@nox_poetry.session(python="3.9")
+def lint(session: nox_poetry.Session):
+    session.notify("black_check")
+    session.notify("flake8")
+    session.notify("isort_check")
+
+
+@nox_poetry.session(python="3.9")
+def flake8(session: nox_poetry.Session):
+    session.install("flake8")
+    session.run("flake8", *LINT_PATHS, "--count", "--show-source", "--statistics", "--benchmark")
+
+
+@nox_poetry.session(python="3.9")
+def black_check(session: nox_poetry.Session):
+    session.install("black")
+    session.run("black", "--check", *LINT_PATHS)
+
+
+@nox_poetry.session(python="3.9")
+def isort_check(session: nox_poetry.Session):
+    session.install("isort")
+    session.run("isort", "--diff", "--profile", "black", "--check", *LINT_PATHS)
+
+
+@nox_poetry.session(python="3.9")
+def blacken(session: nox_poetry.Session):
+    session.install("black")
+    session.run("black", *LINT_PATHS)
+
+
+@nox_poetry.session(python="3.9")
+def isort_apply(session: nox_poetry.Session):
+    session.install("isort")
+    session.run("isort", *LINT_PATHS, "--profile", "black")

noxfile.py

@@ -0,0 +1,3 @@
+[virtualenvs]
+create = true
+in-project = true

poetry.toml

@@ -27,3 +27,32 @@ exclude = '''
 )/
 '''
 skip-string-normalization = true
+
+[tool.poetry]
+name = "vdom"
+version = "0.1.0"
+description = ""
+authors = ["Kyle Kelley <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+ipython = "^8.11.0"
+jsonschema = "^4.17.3"
+
+[tool.poetry.group.dev.dependencies]
+types-jsonschema = "^4.17.0.6"
+pytest = "^7.2.2"
+mypy = "^1.1.1"
+flake8-docstrings = "^1.7.0"
+black = "^23.1.0"
+isort = "^5.12.0"
+pytest-cov = "^4.0.0"
+pytest-asyncio = "^0.21.0"
+nox = "^2022.11.21"
+nox-poetry = "^1.0.2"
+pytest-mock = "^3.10.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -1,3 +1,25 @@
+[metadata]
+name = vdom
+author = nteract contributors
+author_email = [email protected]
+license = BSD
+description = VDOM for Python
+keywords = vdom,, html
+url = https://github.com/nteract/vdom
+long_description = file: README.md
+long_description_content_type = text/markdown
+
+[options]
+packages = vdom
+install_requires = ipython; jsonschema
+include_package_data = True
+
+[options.extras_require]
+tests = pytest
+all = pytest
+
+[options.package_data]
+vdom = schemas/vdom_schema_v0.json
 
 [flake8]
 # References:
@@ -7,6 +29,8 @@
 # Note: there cannot be spaces after comma's here
 exclude = __init__.py
 ignore =
+    # Length of line
+    E501,
     # Extra space in brackets
     E20,
     # Multiple spaces around ","

setup.cfg

@@ -1,10 +1,10 @@
+from ._version import get_versions
 from .core import *
 from .helpers import *
 
-from ._version import get_versions
-
 __version__ = get_versions()['version']
 del get_versions
 
 from . import _version
+
 __version__ = _version.get_versions()['version']