feat(ci): development tooling refresh and split documentation

.pre-commit-config.yaml

@@ -1,7 +1,26 @@
+---
 repos:
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
-    rev: v0.6.4
+  - repo: local
     hooks:
-      - id: ruff-format
+      - id: mypy
+        name: mypy
+        entry: mypy
+        language: system
+        types_or: [python, pyi]
+        require_serial: true
+
       - id: ruff
+        name: ruff
+        entry: ruff check
+        language: system
+        types_or: [python, pyi, jupyter]
+        args: [--force-exclude]
+        require_serial: true
+
+      - id: ruff-format
+        name: ruff-format
+        entry: ruff format
+        language: system
+        types_or: [python, pyi, jupyter]
+        args: [--force-exclude, --check]
+        require_serial: true

contrib/.envrc-nix

@@ -0,0 +1,19 @@
+# shellcheck shell=bash
+
+# If you wish to use this file, symlink or copy it to `.envrc` for direnv to read it.
+# This will use the Nix flake development shell.
+#
+# ln -s contrib/.envrc-nix .envrc
+
+if ! has nix_direnv_version || ! nix_direnv_version 3.0.6; then
+    source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.6/direnvrc" "sha256-RYcUJaRMf8oF5LznDrlCXbkOQrywm0HDv1VjYGaJGdM="
+fi
+
+watch_file nix/shell.nix pyproject.toml
+
+use flake
+
+# Only watch now, or direnv will execute again if created or modified by itself.
+watch_file "${UV_PROJECT_ENVIRONMENT:-.venv}"/bin/activate
+
+# vi: ft=bash

contrib/.envrc-uv

@@ -0,0 +1,32 @@
+# shellcheck shell=bash
+
+# If you wish to use this file, symlink or copy it to `.envrc` for direnv to read it.
+# This will use a virtual environment created by uv.
+#
+# ln -s contrib/.envrc-uv .envrc
+
+watch_file .python-version pyproject.toml uv.lock
+
+venv="$(expand_path "${UV_PROJECT_ENVIRONMENT:-.venv}")"
+
+if [ ! -f "${venv}"/bin/activate ]; then
+    printf '%s\n' 'Generating virtual environment...' >&2
+    rm -rf "${venv}"
+    uv venv "${venv}"
+fi
+
+# Only watch now, or direnv will execute again if created or modified by itself.
+watch_file "${venv}"/bin/activate
+
+# shellcheck disable=SC1091
+source "${venv}"/bin/activate
+
+if [ ! -f "${venv}"/pyproject.toml ] || ! diff --brief pyproject.toml "${venv}"/pyproject.toml >/dev/null; then
+    printf '%s\n' 'Installing dependencies, pyproject.toml changed...' >&2
+    uv pip install --quiet --editable '.[dev]'
+    cp pyproject.toml "${venv}"/pyproject.toml
+fi
+
+pre-commit install
+
+# vi: ft=bash

contrib/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "TagStudio",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceRoot}/src/tagstudio/main.py",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "args": [
+                "-o",
+                "~/Documents/Example"
+            ]
+        }
+    ]
+}

docs/develop.md

@@ -0,0 +1,180 @@
+# Developing
+
+If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarly with existing Python toolchains.
+
+<!-- prettier-ignore -->
+!!! tip "Contributing"
+    If you wish to contribute to TagStudio's development, please read our [CONTRIBUTING.md](https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md)!
+
+## Install Python
+
+Python [3.12](https://www.python.org/downloads) is required to develop for TagStudio. Any version matching "Python 3.12.x" should work, with "x" being any number. Alternatively you can use a tool such as [pyenv](https://github.com/pyenv/pyenv) to install this version of Python without affecting any existing Python installations on your system. Tools such as [uv](#installing-with-uv) can also install Python versions.
+
+<!-- prettier-ignore -->
+!!! info "Python Aliases"
+    Depending on your system, Python may be called `python`, `py`, `python3`, or `py3`. These instructions use the alias `python` for consistency.
+
+If you already have Python installed on your system, you can check the version by running the following command:
+
+```sh
+python --version
+```
+
+---
+
+#### Installing with pyenv
+
+If you choose to install Python using pyenv, please refer to the following instructions:
+
+1. Follow pyenv's [install instructions](https://github.com/pyenv/pyenv/?tab=readme-ov-file#installation) for your system.
+2. Install the appropriate Python version with pyenv by running `pyenv install 3.12` (This will **not** mess with your existing Python installation).
+3. Navigate to the repository root folder in your terminal and run `pyenv local 3.12`. You could alternatively use `pyenv shell 3.12` or `pyenv global 3.12` instead to set the Python version for the current terminal session or the entire system respectively, however using `local` is recommended.
+
+---
+
+### Installing Dependencies
+
+To install the required dependencies, you can use a dependency manager such as [uv](https://docs.astral.sh/uv) or [Poetry 2.0](https://python-poetry.org). Alternatively you can create a virtual environment and manually install the dependencies yourself.
+
+#### Installing with uv
+
+If using [uv](https://docs.astral.sh/uv), you can install the dependencies for TagStudio with the following command:
+
+```sh
+uv pip install -e .[dev]
+```
+
+A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/.envrc-uv`](https://github.com/TagStudioDev/TagStudio/blob/main/contrib/.envrc-uv).
+
+---
+
+#### Installing with Poetry
+
+If using [Poetry](https://python-poetry.org), you can install the dependencies for TagStudio with the following command:
+
+```sh
+poetry install --with dev
+```
+
+---
+
+#### Manual Installation
+
+If you choose to manually set up a virtual environment and install dependencies instead of using a dependency manager, please refer to the following instructions:
+
+<!-- prettier-ignore -->
+!!! tip "Virtual Environments"
+    Learn more about setting up a virtual environment with Python's [official tutorial](https://docs.python.org/3/tutorial/venv.html).
+
+1.  In the root repository directory, create a python virtual environment:
+
+    ```sh
+    python -m venv .venv
+    ```
+
+2.  Activate your environment:
+
+    -   Windows w/Powershell: `.venv\Scripts\Activate.ps1`
+    -   Windows w/Command Prompt: `.venv\Scripts\activate.bat`
+    -   Linux/macOS: `source .venv/bin/activate`
+
+    <!-- prettier-ignore -->
+    !!! info "Supported Shells"
+        Depending on your system, the regular activation script _might_ not work on alternative shells. In this case, refer to the table below for supported shells:
+
+        |      Shell | Script                    |
+        | ---------: | :------------------------ |
+        |   Bash/ZSH | `.venv/bin/activate`      |
+        |       Fish | `.venv/bin/activate.fish` |
+        |   CSH/TCSH | `.venv/bin/activate.csh`  |
+        | PowerShell | `.venv/bin/activate.ps1`  |
+
+3.  Use the following PIP command to create an editable installation and install the required development dependencies:
+
+    ```sh
+    pip install -e .[dev]
+    ```
+
+## Nix(OS)
+
+If using [Nix](https://nixos.org/), there is a development environment already provided in the [flake](https://wiki.nixos.org/wiki/Flakes) that is accessible with the following command:
+
+```sh
+nix develop
+```
+
+A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/.envrc-nix`](https://github.com/TagStudioDev/TagStudio/blob/main/contrib/.envrc-nix).
+
+## Tooling
+
+### Editor Integration
+
+The entry point for TagStudio is `src/tagstudio/main.py`. You can target this file from your IDE to run or connect a debug session. The example(s) below show off example launch scripts for different IDEs. Here you can also take advantage of [launch arguments](./usage.md/#launch-arguments) to pass your own test [libraries](./library/index.md) to use while developing. You can find more editor configurations in [`contrib`](https://github.com/TagStudioDev/TagStudio/tree/main/contrib).
+
+<!-- prettier-ignore -->
+=== "VS Code"
+    ```json title=".vscode/launch.json"
+    {
+        "version": "0.2.0",
+        "configurations": [
+            {
+                "name": "TagStudio",
+                "type": "python",
+                "request": "launch",
+                "program": "${workspaceRoot}/src/tagstudio/main.py",
+                "console": "integratedTerminal",
+                "justMyCode": true,
+                "args": ["-o", "~/Documents/Example"]
+            }
+        ]
+    }
+    ```
+
+### pre-commit
+
+There is a [pre-commit](https://pre-commit.com/) configuration that will run through some checks before code is committed. Namely, mypy and the Ruff linter and formatter will check your code, catching those nits right away.
+
+Once you have pre-commit installed, just run:
+
+```sh
+pre-commit install
+```
+
+From there, Git will automatically run through the hooks during commit actions!
+
+### direnv
+
+You can automatically enter this development shell, and keep your user shell, with a tool like [direnv](https://direnv.net/). Some reference `.envrc` files are provided in the repository at [`contrib`](https://github.com/TagStudioDev/TagStudio/tree/main/contrib).
+
+Two currently available are for [Nix](#nixos) and [uv](#installing-with-uv), to use one:
+
+```sh
+ln -s .envrc-$variant .envrc
+```
+
+You will have to allow usage of it.
+
+<!-- prettier-ignore -->
+!!! warning "direnv Security Framework"
+    These files are generally a good idea to check, as they execute commands on directory load. direnv has a security framework to only run `.envrc` files you have allowed, and does keep track on if it has changed. So, with that being said, the file may need to be allowed again if modifications are made.
+
+```sh
+cat .envrc # You are checking them, right?
+direnv allow
+```
+
+## Building
+
+To build your own executables of TagStudio, first follow the steps in "[Installing Dependencies](#installing-dependencies)." Once that's complete, run the following PyInstaller command:
+
+```
+pyinstaller tagstudio.spec
+```
+
+If you're on Windows or Linux and wish to build a portable executable, then pass the following flag:
+
+```
+pyinstaller tagstudio.spec -- --portable
+```
+
+The resulting executable file(s) will be located in a new folder named "dist".