Merge pull request #46 from agoose77/agoose77/maint-upgrade-developmentwq

maint: improve dev experience

Author: agoose77

.github/workflows/ci-cd.yml

@@ -20,10 +20,10 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.10"
+          - "3.13"
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -38,7 +38,7 @@ jobs:
           pip install twine
           twine check dist/*
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: build
           path: dist/*
@@ -56,11 +56,11 @@ jobs:
           - "3.10"
           - "3.11"
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: build
           path: dist
@@ -76,7 +76,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event_name == 'release' && github.event.action == 'published'
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: build
           path: dist

README.md

@@ -15,6 +15,9 @@
 [wiki]: https://github.com/agoose77/literary/wiki
 
 ## TL;DR
+> [!Info]
+> To get started, see [the wiki]
+
 Literary is a Python tool to make Jupyter (IPython) notebooks behave like pure-Python packages. This allows pure-Python packages to be generated from notebooks, and notebooks to be imported at runtime. Literary now [bootstraps itself](https://en.wikipedia.org/wiki/Bootstrapping); it is developed with Literary 🤯.
 
 This package is an exploration of the [literate programming](http://www.literateprogramming.com) idea [pioneered by
@@ -37,3 +40,5 @@ notebooks
  be generated from the notebooks, and it must use the conventional import model. For
  this reason, `literary` should only exist as a development dependency of
  the package.
+
+[the wiki]: https://github.com/agoose77/literary/wiki

flake.lock

@@ -0,0 +1,75 @@
+# code-owner: @agoose77
+# This flake sets up an FSH dev-shell that installs all the required
+# packages for running deployer, and then installs the tool in the virtual environment
+# It is not best-practice for the nix-way of distributing this code,
+# but its purpose is to get an environment up and running.
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+  outputs = {
+    self,
+    nixpkgs,
+    flake-utils,
+  }:
+    flake-utils.lib.eachDefaultSystem (system: let
+      pkgs = nixpkgs.legacyPackages.${system};
+      inherit (pkgs) lib;
+
+      python = pkgs.python313;
+      packages =
+        [
+          python
+        ]
+        ++ (with pkgs; [
+          cmake
+          ninja
+          gcc
+          pre-commit
+          # Infra packages
+          nodejs
+        ]);
+      shellHook = ''
+        # Unset leaky PYTHONPATH
+        unset PYTHONPATH
+
+        __hash=$(echo ${python.interpreter} | sha256sum)
+
+        # Setup if not defined ####
+        if [[ ! -f ".venv/$__hash" ]]; then
+            __setup_env() {
+                # Remove existing venv
+                if [[ -d .venv ]]; then
+                    rm -r .venv
+                fi
+
+                # Stand up new venv
+                ${python.interpreter} -m venv .venv
+
+                ".venv/bin/python" -m pip install --group develop
+
+                # Add a marker that marks this venv as "ready"
+                touch ".venv/$__hash"
+            }
+
+            __setup_env
+        fi
+        ###########################
+
+        export PYTHONPATH="$(git rev-parse --show-toplevel)/lib/"
+
+        # Activate venv
+        source .venv/bin/activate
+      '';
+      env = lib.optionalAttrs pkgs.stdenv.isLinux {
+        # Python uses dynamic loading for certain libraries.
+        # We'll set the linker path instead of patching RPATH
+        LD_LIBRARY_PATH = lib.makeLibraryPath pkgs.pythonManylinuxPackages.manylinux2014;
+      };
+    in {
+      devShell = pkgs.mkShell {
+        inherit env packages shellHook;
+      };
+    });
+}

flake.nix

@@ -6,16 +6,15 @@ authors = [
     {name = "Angus Hollands", email = "goosey15@gmail.com"},
 ]
 dependencies = [
-    "nbformat[fast]>=5",
+    "nbformat>=5.10",
     "nbclient>=0.5.12",
     "nbconvert>=6.0",
     "traitlets>=5",
-    "astunparse>=1.6; python_version < \"3.9\"",
-    "ipython>=7.33.0",
+    "ipython>=7.33",
     "typing-extensions>=3.10",
     "jupyter-core>=4.7",
 ]
-requires-python = ">=3.7"
+requires-python = ">=3.9"
 readme = "README.md"
 license = {file = "LICENSE"}
 classifiers = [
@@ -27,9 +26,11 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.7",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9"]
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13"]
 keywords = [
     "literate-programming",
     "jupyter",
@@ -49,16 +50,15 @@ literary = "literary.transpile.exporter:LiteraryExporter"
 
 [project.optional-dependencies]
 
-[tool]
-[tool.pdm]
-[tool.pdm.dev-dependencies]
-dev = [
+[dependency-groups]
+develop = [
     "jupyterlab>=3.4.0",
     "pytest>=7.1.2",
-    "literary>=4.0.0",
     "jupyterlab-code-formatter>=1.4.11",
     "black>=22.3.0",
     "isort>=5.10.1",
+    # Needed for building literary live!
+    "literary>=4.0.1"
 ]
 
 [tool.hatch.build]

pyproject.toml

@@ -0,0 +1,33 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "9a348033-a307-4274-968d-680c360978c7",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}