Updated files to match project template (#26)

Author: spietras

.github/release-drafter.yml renamed to .github/release-drafter.yaml

@@ -7,6 +7,9 @@ categories:
   - title: "🐛 Bug Fixes"
     labels:
       - "bug"
+  - title: "🧽 Cleanup"
+    labels:
+      - "cleanup"
 exclude-labels:
   - "skip-changelog"
 change-title-escapes: '\<*_&'

.github/workflows/docs.yml renamed to .github/workflows/docs.yaml

@@ -9,7 +9,7 @@ on:
     # trigger only on changes to the following files
     paths:
       - "kilroy_module_pytorch_py_sdk/docs/**"
-      - ".github/workflows/docs.yml"
+      - ".github/workflows/docs.yaml"
 
 # env for all jobs
 env:
@@ -24,17 +24,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Cache packages
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ${{ env.PIP_CACHE_DIR }}
           key: ${{ runner.os }}-pkgs-${{ env.CACHE_NUMBER }}
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: "3.9.7"
+          python-version: "3.10.6"
       - name: Set up pip cache
         run: python3 -m pip config set global.cache-dir ${{ env.PIP_CACHE_DIR }}
       - name: Install mkdocs

.github/workflows/draft.yml renamed to .github/workflows/draft.yaml

@@ -13,8 +13,8 @@ on:
       - "kilroy_module_pytorch_py_sdk/README.md"
       - "kilroy_module_pytorch_py_sdk/poetry.lock"
       - "kilroy_module_pytorch_py_sdk/pyproject.toml"
-      - ".github/workflows/draft.yml"
-      - ".github/release-drafter.yml"
+      - ".github/workflows/draft.yaml"
+      - ".github/release-drafter.yaml"
 
 jobs:
   draft:
@@ -24,7 +24,7 @@ jobs:
     steps:
       - uses: release-drafter/release-drafter@v5
         with:
-          config-name: release-drafter.yml
+          config-name: release-drafter.yaml
           disable-autolabeler: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint.yaml

@@ -0,0 +1,31 @@
+name: Lint
+
+on:
+  workflow_dispatch:
+  push:
+    # trigger only on main branch
+    branches:
+      - main
+    # trigger only on changes to the following files
+    paths:
+      - "kilroy_module_pytorch_py_sdk/src/**"
+      - "kilroy_module_pytorch_py_sdk/tests/**"
+      - ".github/workflows/test-docker.yaml"
+  pull_request:
+    # trigger only on main branch
+    branches:
+      - main
+    # trigger only on changes to the following files
+    paths:
+      - "kilroy_module_pytorch_py_sdk/src/**"
+      - "kilroy_module_pytorch_py_sdk/tests/**"
+      - ".github/workflows/test-docker.yaml"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable
+        with:
+          src: "./kilroy_module_pytorch_py_sdk"

.github/workflows/pypi.yml renamed to .github/workflows/pypi.yaml

@@ -19,19 +19,19 @@ jobs:
     steps:
       - # get repository code
         name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - # get conda, poetry and pip cache (persistent between runs)
         name: Cache packages
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ${{ env.POETRY_CACHE_DIR }}
             ${{ env.PIP_CACHE_DIR }}
           key: ${{ runner.os }}-pkgs-${{ env.CACHE_NUMBER }} }}
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: "3.9.7"
+          python-version: "3.10.6"
       - name: Set up pip cache
         run: python3 -m pip config set global.cache-dir ${{ env.PIP_CACHE_DIR }}
       - name: Install poetry

.github/workflows/test-multiplatform.yml renamed to .github/workflows/test-multiplatform.yaml

@@ -12,9 +12,9 @@ on:
       - "kilroy_module_pytorch_py_sdk/tests/**"
       - "kilroy_module_pytorch_py_sdk/poetry.lock"
       - "kilroy_module_pytorch_py_sdk/pyproject.toml"
-      - "environment.yml"
+      - "environment.yaml"
       - "requirements.txt"
-      - ".github/workflows/test-multiplatform.yml"
+      - ".github/workflows/test-multiplatform.yaml"
   pull_request:
     # trigger only on main branch
     branches:
@@ -25,9 +25,9 @@ on:
       - "kilroy_module_pytorch_py_sdk/tests/**"
       - "kilroy_module_pytorch_py_sdk/poetry.lock"
       - "kilroy_module_pytorch_py_sdk/pyproject.toml"
-      - "environment.yml"
+      - "environment.yaml"
       - "requirements.txt"
-      - ".github/workflows/test-multiplatform.yml"
+      - ".github/workflows/test-multiplatform.yaml"
 
 # env for all jobs
 env:
@@ -57,20 +57,20 @@ jobs:
     steps:
       - # get repository code
         name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - # get conda, poetry and pip cache (persistent between runs)
         name: Cache packages
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ${{ env.CONDA_CACHE_DIR }}
             ${{ env.POETRY_CACHE_DIR }}
             ${{ env.PIP_CACHE_DIR }}
           key: ${{ runner.os }}-pkgs-${{ env.CACHE_NUMBER }}
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: "3.9.7"
+          python-version: "3.10.6"
       - name: Set up pip cache
         run: python3 -m pip config set global.cache-dir ${{ env.PIP_CACHE_DIR }}
       - name: Install poetry
@@ -82,13 +82,13 @@ jobs:
         uses: conda-incubator/setup-miniconda@v2
         with:
           activate-environment: kilroy-module-pytorch-py-sdk
-          environment-file: environment.yml
+          environment-file: environment.yaml
           # necessary for caching to work
           use-only-tar-bz2: true
       - # install only dependencies
         name: Install dependencies
         working-directory: kilroy_module_pytorch_py_sdk
-        run: poetry install --no-root --extras test
+        run: poetry install --no-root --only main,test
       - # workaround for non-editable install, waiting for https://github.com/python-poetry/poetry/issues/1382
         name: Build package
         working-directory: kilroy_module_pytorch_py_sdk

.gitignore

@@ -129,3 +129,5 @@ dmypy.json
 .pyre/
 
 .idea/
+
+!.gitkeep

README.md

@@ -4,8 +4,9 @@
 
 SDK for kilroy modules using PyTorch 🧰
 
-[![Tests](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/test-multiplatform.yml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/test-multiplatform.yml)
-[![Docs](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/docs.yml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/docs.yml)
+[![Lint](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/lint.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/lint.yaml)
+[![Tests](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/test-multiplatform.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/test-multiplatform.yaml)
+[![Docs](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/docs.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/docs.yaml)
 
 </div>
 
@@ -27,10 +28,10 @@ $ curl -sSL https://repo.anaconda.com/miniconda/Miniconda3-py39_4.10.3-Linux-x86
 $ bash miniconda.sh && exec bash
 (base) $ git clone https://github.com/kilroybot/kilroy-module-pytorch-py-sdk
 (base) $ cd kilroy_module_pytorch_py_sdk
-(base) $ conda env create -f environment.yml
+(base) $ conda env create -f environment.yaml
 (base) $ conda activate kilroy-module-pytorch-py-sdk
 (kilroy-module-pytorch-py-sdk) $ cd kilroy_module_pytorch_py_sdk
-(kilroy-module-pytorch-py-sdk) $ poetry install --extras dev
+(kilroy-module-pytorch-py-sdk) $ poetry install --sync
 ```
 
 ## Quickerstart
@@ -54,7 +55,7 @@ The first step is of course to install [`conda`](https://conda.io).
 To create an environment, run from project root:
 
 ```sh
-conda env create -f environment.yml
+conda env create -f environment.yaml
 ```
 
 And then activate it by:
@@ -66,11 +67,11 @@ conda activate kilroy-module-pytorch-py-sdk
 Creating the environment is performed only once, but you need to activate it
 every time you start a new shell.
 
-If the configuration file `environment.yml` changes, you can update the
+If the configuration file `environment.yaml` changes, you can update the
 environment by:
 
 ```sh
-conda env update -f environment.yml
+conda env update -f environment.yaml
 ```
 
 ## Package management
@@ -83,12 +84,11 @@ To install the package, you need to `cd`
 into `kilroy_module_pytorch_py_sdk` directory and run:
 
 ```sh
-poetry install --extras dev --remove-untracked
+poetry install --sync
 ```
 
-This will download and install all package dependencies (including optional
-development ones) and install the package in editable mode into the activated
-environment.
+This will download and install all package dependencies (including development
+ones) and install the package in editable mode into the activated environment.
 
 Editable mode means that you don't have to reinstall the package if you change
 something in the code. The changes are reflected automatically.
@@ -108,10 +108,10 @@ We are using [`pytest`](https://pytest.org) for tests. It's already installed
 in the environment, because it's a development-time dependency. To start first
 write the tests and put them in `kilroy_module_pytorch_py_sdk/tests`.
 
-To execute the tests, run from project root:
+To execute the tests, `cd` into `kilroy_module_pytorch_py_sdk` and run:
 
 ```sh
-pytest kilroy_module_pytorch_py_sdk
+poe test
 ```
 
 ## Building docs
@@ -124,14 +124,14 @@ creates a nice webpage for them.
 Docs should be placed in `kilroy_module_pytorch_py_sdk/docs/docs`. They
 are pretty straightforward to write.
 
-To build the docs,
-`cd` into `kilroy_module_pytorch_py_sdk/docs` and run:
+To build and serve the docs,
+`cd` into `kilroy_module_pytorch_py_sdk` and run:
 
 ```sh
-mkdocs build
+poe docs
 ```
 
-It will generate `site` directory with the webpage source.
+It will generate `site` directory with the webpage source and serve it.
 
 ## Adding new dependencies
 
@@ -144,7 +144,7 @@ After that update the installation by running
 from `kilroy_module_pytorch_py_sdk` directory:
 
 ```sh
-poetry update
+poe update
 ```
 
 This will install anything new in your environment and update the `poetry.lock`
@@ -172,8 +172,8 @@ it means the commit broke something (or workflows themselves are broken).
 
 Every time you merge a pull request into main, a draft release is automatically
 updated, adding the pull request to changelog. Changes can be categorized by
-using labels. You can configure that in `.github/release-drafter.yml` file.
+using labels. You can configure that in `.github/release-drafter.yaml` file.
 
-Every time you publish a release the package is uploaded to PyPI
-with version taken from release tag
+Every time you publish a release the package is uploaded to PyPI 
+with version taken from release tag 
 (you should store your PyPI token in `PYPI_TOKEN` secret).

environment.yaml

@@ -0,0 +1,7 @@
+name: kilroy-module-pytorch-py-sdk
+channels:
+  - defaults
+  - conda-forge
+dependencies:
+  - python==3.10.6
+  - pip==22.2.2

environment.yml

@@ -4,8 +4,9 @@
 
 SDK for kilroy modules using PyTorch 🧰
 
-[![Tests](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/test-multiplatform.yml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/test-multiplatform.yml)
-[![Docs](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/docs.yml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/docs.yml)
+[![Lint](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/lint.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/lint.yaml)
+[![Tests](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/test-multiplatform.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/test-multiplatform.yaml)
+[![Docs](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/docs.yaml/badge.svg)](https://github.com/kilroybot/kilroy-module-pytorch-py-sdk/actions/workflows/docs.yaml)
 
 </div>
 

kilroy_module_pytorch_py_sdk/README.md

@@ -1,20 +1,24 @@
-click==8.0.3
-ghp-import==2.0.2
-importlib-metadata==4.11.1
-Jinja2==3.0.3
-Markdown==3.3.6
-MarkupSafe==2.0.1
+charset-normalizer==2.1.1
+click==8.1.3
+ghp-import==2.1.0
+idna==3.4
+importlib-metadata==4.12.0
+Jinja2==3.1.2
+Markdown==3.3.7
+MarkupSafe==2.1.1
 mergedeep==1.3.4
-mkdocs==1.2.3
-mkdocs-material==8.1.11
+mkdocs==1.3.1
+mkdocs-material==8.5.3
 mkdocs-material-extensions==1.0.3
 packaging==21.3
-Pygments==2.11.2
-pymdown-extensions==9.2
-pyparsing==3.0.7
+Pygments==2.13.0
+pymdown-extensions==9.5
+pyparsing==3.0.9
 python-dateutil==2.8.2
 PyYAML==6.0
 pyyaml_env_tag==0.1
+requests==2.28.1
 six==1.16.0
-watchdog==2.1.6
-zipp==3.7.0
+urllib3==1.26.12
+watchdog==2.1.9
+zipp==3.8.1