Add local dev environment setup options

Add support for uv and pip installation methods as alternatives to
Conda/Docker. Update pyproject.toml with proper project metadata and
structured development dependencies.

Author: edoardob90

.gitignore

@@ -80,6 +80,9 @@ target/
 # IPython
 profile_default/
 
+# uv
+uv.lock
+
 # pyenv
 .python-version
 

README.md

@@ -127,3 +127,62 @@ You can now use the Jupyter in the Docker container to run the python-tutorial.
 > [!NOTE]
 >
 > If you want to restart the container, you can simply run the command `docker container start python_tutorial`.
+
+## Setup a local dev environment
+
+If you prefer not to use Conda and/or Docker, you can set up a *lightweight* development environment using either "uv" (a faster alternative to pip) or traditional "pip". Both methods will install the development dependencies specified in the `pyproject.toml` file.
+
+### Using `uv` (Recommended for speed)
+
+[uv](https://github.com/astral-sh/uv) is a fast, Python package installer and resolver written in Rust.
+
+1. Install uv via `pip` or any other method:
+   ```console
+   pip install uv
+   ```
+
+2. Create a virtual environment and install dev dependencies:
+   ```console
+   # Clone the repository if you haven't already
+   git clone https://github.com/empa-scientific-it/python-tutorial
+   cd python-tutorial
+
+   # Create and activate a virtual environment
+   uv venv
+   # On Windows
+   .venv\Scripts\activate
+   # On macOS/Linux
+   source .venv/bin/activate
+
+   # Install dev dependencies
+   uv pip install -e ".[dev]"
+   ```
+
+3. Launch JupyterLab:
+   ```console
+   jupyter lab
+   ```
+
+### Using `pip`
+
+1. Create a virtual environment and install dev dependencies:
+   ```console
+   # Clone the repository if you haven't already
+   git clone https://github.com/empa-scientific-it/python-tutorial
+   cd python-tutorial
+
+   # Create and activate a virtual environment
+   python -m venv .venv
+   # On Windows
+   .venv\Scripts\activate
+   # On macOS/Linux
+   source .venv/bin/activate
+
+   # Install dev dependencies
+   pip install -e ".[dev]"
+   ```
+
+2. Launch JupyterLab:
+   ```console
+   jupyter lab
+   ```

pyproject.toml

@@ -1,19 +1,57 @@
+[project]
+name = "python-tutorial"
+version = "v2025.05"
+description = "Jupyter-based Python programming tutorial"
+requires-python = ">=3.10"
+
+[project.optional-dependencies]
+dev = [
+  "numpy",
+  "matplotlib",
+  "pandas",
+  "ipywidgets",
+  "ipynbname",
+  "jupyterlab",
+  "pytest",
+  "pytest-timeout",
+  "markdown",
+  "pre-commit",
+  "geostatspy",
+  "gstools",
+  "scikit-learn",
+  "attrs",
+  "multiprocess",
+  "openai",
+  "tenacity",
+  "markdown2",
+  "python-dotenv",
+  "pillow",
+  "opencv-python",
+  "albumentations",
+  "grad-cam",
+  "plotly",
+  "torch==2.7.0",  # pinned to last stable version as of 2025-05-14
+]
+
+# pytest
+[tool.pytest.ini_options]
+addopts = "-v --tb=short"
+
+# Ruff
 [tool.ruff]
 # Line length (Black default)
 line-length = 88
-
 # Python target version
-target-version = "py38"
+target-version = "py310"
 
 # Ignored rules for the entire project
 [tool.ruff.lint]
 ignore = [
-    "E501", # Line too long
-    "E203", # Whitespace before ':'
-    # "TRY301", # Raise within try block (this is actually a good practice)
-    # "W503"  # Line break before binary operator (not PEP8 enforced, so not implemented in Ruff)
+  "E501",  # Line too long
+  "E203",  # Whitespace before ':'
+  # "TRY301", # Raise within try block (this is actually a good practice)
+  # "W503"  # Line break before binary operator (not PEP8 enforced, so not implemented in Ruff)
 ]
-
 # flake8 plugins to enable:
 #   - flake8-bugbear          B
 #   - flake8-builtins         A
@@ -24,31 +62,29 @@ ignore = [
 #   - pyflakes                F
 #   - tryceratops             TRY
 select = [
-    "A",   # flake8-builtins
-    "B",   # flake8-bugbear
-    "C4",  # flake8-comprehensions
-    "T10", # flake8-debugger
-    "G",   # flake8-logging-format
-    "N",   # pep8-naming
-    "F",   # pyflakes
-    "TRY", # tryceratops
-    "I",   # isort
-    "E",   # pycodestyle errors
-    "UP",  # pyupgrade
+  "A",  # flake8-builtins
+  "B",  # flake8-bugbear
+  "C4",  # flake8-comprehensions
+  "T10",  # flake8-debugger
+  "G",  # flake8-logging-format
+  "N",  # pep8-naming
+  "F",  # pyflakes
+  "TRY",  # tryceratops
+  "I",  # isort
+  "E",  # pycodestyle errors
+  "UP",  # pyupgrade
 ]
 
 # Per-file rule ignores
 [tool.ruff.lint.per-file-ignores]
 # Trailing whitespace in comment
 "binder/ipython_config.py" = ["E266"]
-
 # suppress `raise ... from err`
 # Why we ignore B904 from the object-oriented tests?
 # We do want to raise an assertion error if the check on the solution function attributes fails,
 # but Python by default will raise a TypeError via vars(solution_result)
 # if the result is not a class and therefore doesn't have a __dict__ attribute.
 "tutorial/tests/test_object_oriented_programming.py" = ["B904"]
-
 # Ignore invalid names like `import torch.nn.functional as F`
 "25_library_pytorch_language_modeling.ipynb" = ["N812"]
 
@@ -57,6 +93,6 @@ select = [
 quote-style = "double"
 indent-style = "space"
 
-# pytest
-[tool.pytest.ini_options]
-addopts = "-v --tb=short"
+# Setuptools: suppress package discovery
+[tool.setuptools]
+packages = []