Merge pull request #67 from Zsailer/refactor

Refactor for Jupyter Releaser, Jupyter Packaging, and Myst Documentation

.github/workflows/check_release.yml

@@ -0,0 +1,55 @@
+name: Check Release
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["*"]
+
+jobs:
+  check_release:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        group: [check_release, link_check]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+          architecture: "x64"
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-pip-
+      - name: Cache checked links
+        if: ${{ matrix.group == 'link_check' }}
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pytest-link-check
+          key: ${{ runner.os }}-linkcheck-${{ hashFiles('**/*.md', '**/*.rst') }}-md-links
+          restore-keys: |
+            ${{ runner.os }}-linkcheck-
+      - name: Upgrade packaging dependencies
+        run: |
+          pip install --upgrade pip setuptools wheel --user
+      - name: Install Dependencies
+        run: |
+          pip install -e .
+      - name: Check Release
+        if: ${{ matrix.group == 'check_release' }}
+        uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Run Link Check
+        if: ${{ matrix.group == 'link_check' }}
+        uses: jupyter-server/jupyter_releaser/.github/actions/check-links@v1

.github/workflows/unittest.yml

@@ -1,29 +1,31 @@
 name: Jupyter Telemetry Unit Tests
 on:
   push:
-    branches: '*'
+    branches: "*"
   pull_request:
-    branches: '*'
+    branches: "*"
 jobs:
   build:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [ '3.5', '3.6', '3.7', '3.8' ]
+        python-version: ["3.6", "3.7", "3.8", "3.9"]
+        exclude:
+          - os: macos-latest
+            python-version: "3.6"
     steps:
-    - name: Checkout
-      uses: actions/checkout@v1
-    - name: Install Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-        architecture: 'x64'
-    - name: Install the Python dependencies
-      run: |
-        pip install -r dev-requirements.txt
-        pip install -e .
-    - name: Run the tests
-      run: |
-        pytest
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Install Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: "x64"
+      - name: Install the Python dependencies
+        run: |
+          pip install -e ".[test]"
+      - name: Run the tests
+        run: |
+          pytest jupyter_telemetry

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
+
 ## v0.1.0
 
 - Ensure unique loggers [#45](https://github.com/jupyter/telemetry/pull/45)

MANIFEST.in

@@ -3,5 +3,5 @@ include *.md
 include *requirements.txt
 include package.json
 
-graft tests
-graft src
+graft docs
+graft proposal

RELEASE.md

@@ -0,0 +1,6 @@
+# Release Workflow
+
+Releases are made (and automated) using [Jupyter-releaser](https://github.com/jupyter-server/jupyter_releaser).
+
+- [ ] Set up a fork of `jupyter-releaser` if you have not yet done so.
+- [ ] Run through the release process, targeting this repo and the appropriate branch

docs/conf.py

@@ -28,6 +28,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "myst_parser"
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -44,10 +45,11 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'pydata_sphinx_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-master_doc = 'index'
+master_doc = 'index'
+html_logo = "_static/jupyter_telemetry_logo.svg"