Dev (#10)

* cleanup files

* add jupyterlab as dev dependency

* remove pre-commit from CI as it's enabled at pre-commit.ci

Author: mdtanker

.github/workflows/ci.yml

@@ -18,8 +18,8 @@ env:
   FORCE_COLOR: 3
 
 jobs:
-  pre-commit:
-    name: Format
+  lint:
+    name: Pylint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -28,19 +28,19 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
-
       - uses: astral-sh/setup-uv@v6
 
-      - uses: pre-commit/action@v3.0.1
-        with:
-          extra_args: --hook-stage manual --all-files
+      # comment out the below 3 lines if your set up pre-commit in pre-commit.ci
+      # - uses: pre-commit/action@v3.0.1
+      #   with:
+      #     extra_args: --hook-stage manual --all-files
+
       - name: Run Pylint
         run: uvx nox -s pylint -- --output-format=github
 
   checks:
     name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
     runs-on: ${{ matrix.runs-on }}
-    needs: [pre-commit]
     strategy:
       fail-fast: false
       matrix:
@@ -66,7 +66,7 @@ jobs:
       - name: Install package
         run: uv sync
 
-      - name: Test package
+      - name: Run the tests
         run: >-
           uv run pytest -ra --cov --cov-report=xml --cov-report=term
           --durations=20

CONTRIBUTING.md

@@ -94,7 +94,7 @@ download and install anything:
 * We'll review your changes and then merge them in if everything is OK.
 * Done 🎉🍺
 
-Alternatively, you can make the changes offline to the files in the `doc` folder or the
+Alternatively, you can make the changes offline to the files in the `docs` folder or the
 example scripts. See [Contributing Code](#contributing-code) for instructions.
 
 ## Contributing Code
@@ -159,7 +159,7 @@ Now we need to configure Git to sync this fork to the main repository, not your
 `cd` into the directory you just cloned and run:
 
 ```bash
-git remote add upstream https://github.com/organizationname/samplepackagenamee.git
+git remote add upstream https://github.com/organizationname/samplepackagename.git
 ```
 
 ### Setting up `nox`
@@ -387,10 +387,8 @@ PyPI release are made automatically via GitHub actions whenever a pull request i
 ### Conda-Forge
 Once the new version is on PyPI, within a few hours a bot will automatically open a new PR in the [samplepackagename conda-forge feedstock](https://github.com/conda-forge/samplepackagename-feedstock). Go through the checklist on the PR. Most of the time the only actions needs are updated any changes made to the dependencies since the last release. Merge the PR and the new version will be available on conda-forge shortly.
 
-Once the new version is on conda, update the binder .yml file, as below.
-
 ## Update the dependencies
 
 To add or update a dependencies, add it to `pyproject.toml` either under `dependencies` or `optional-dependencies`. This will be included in the next build uploaded to PyPI.
 
-If you add a dependency necessary for using the package, make sure to add it to the Binder config file and update the `environment.yml` file in the repository. See below.
+If you add a dependency necessary for using the package, make sure to update the `environment.yml` file in the repository. See below.

docs/conf.py

@@ -101,19 +101,3 @@
     "source_branch": "main",
     "source_directory": "docs/",
 }
-
-# html_theme = "sphinx_book_theme"
-# html_theme_options = {
-#     "repository_url": "https://github.com/organizationname/samplepackagename",
-#     "repository_branch": "main",
-#     "path_to_docs": "docs",
-#     "launch_buttons": {
-#         "binderhub_url": "https://mybinder.org",
-#         "notebook_interface": "jupyterlab",
-#     },
-#     "use_edit_page_button": True,
-#     "use_issues_button": True,
-#     "use_repository_button": True,
-#     "use_download_button": True,
-#     "home_page_in_toc": False,
-# }

docs/install.md

@@ -1,12 +1,5 @@
 # Install
 
-## Online usage (Binder)
-
-See below for the full installation instructions.
-If instead you'd like to use this package online, without needing to install anything, check out our [Binder link](https://mybinder.org/v2/gh/organizationname/samplepackagename/main), which gives full access the the package in an online environment.
-
-This Binder environment can also be accessed by clicking the Binder icon in any of the `gallery` or `tutorial` examples.
-
 ## Install Python
 
 Before installing _samplepackagename_, ensure you have Python 3.9 or greater downloaded.

pyproject.toml

@@ -40,6 +40,7 @@ test = [
 ]
 dev = [
   { include-group = "test" },
+  "jupyterlab",
 ]
 docs = [
   "sphinx>=7.0",