Update

.github/workflows/docs.yaml

@@ -0,0 +1,30 @@
+name: docs
+
+on:
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - run: |
+          pip install pip -U
+          pip install -e .[dev]
+
+      - run: sphinx-build docs/source docs/build --fail-on-warning

.github/workflows/pytest.yaml

@@ -1,25 +1,38 @@
-name: Run pytest
+name: CI
 
-on: [push, pull_request]
+on:
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  pytest:
     strategy:
+      fail-fast: false
+
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install pytest and self
-        run: |
-          python -m pip install --upgrade pip
-          pip install pytest
-          pip install .
-      - name: Test with pytest
-        run: |
+
+      - run: |
+          pip install pip -U
+          pip install -e .[dev]
+
+      - run: |
           pytest

.github/workflows/ruff.yaml

@@ -1,10 +1,46 @@
-name: Lint by Ruff
+name: staticcheck
 
-on: [push, pull_request]
+on:
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   ruff:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v3
-      - uses: chartboost/ruff-action@v1
+      - uses: actions/checkout@v4
+
+      - name: Ruff (lint)
+        uses: chartboost/ruff-action@v1
+
+      - name: Ruff (format)
+        uses: chartboost/ruff-action@v1
+        with:
+          args: "format --check"
+
+  typecheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - run: |
+          pip install pip -U
+          pip install -e .[dev]
+
+      - run: mypy
+
+      - run: pyright

.gitignore

@@ -92,7 +92,7 @@ ipython_config.py
 #   However, in case of collaboration, if having platform-specific dependencies or dependencies
 #   having no cross-platform support, pipenv may install dependencies that don't work, or not
 #   install all needed dependencies.
-#Pipfile.lock
+Pipfile.lock
 
 # poetry
 #   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [year] [fullname]
+Copyright (c) 2022 Todo group
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Pipfile

@@ -0,0 +1,11 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+pypkg-template = {extras = ["dev"], file = ".", editable = true}
+
+[dev-packages]
+pytest-sugar = "*"
+ipython = "*"

README.md

@@ -1,16 +1,32 @@
 # pypkg_template
 
-Python package template with the modern toml-based style.
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/todo-group/pypkg_template/actions/workflows/pytest.yaml/badge.svg)](https://github.com/todo-group/pypkg_template/actions/workflows/pytest.yaml)
+[![docs](https://github.com/todo-group/pypkg_template/actions/workflows/docs.yaml/badge.svg)](https://github.com/todo-group/pypkg_template/actions/workflows/docs.yaml)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
+Python package template with the modern toml-based style.
 
 See [here](https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html) for more details.
 
 ## How to use
+
+### `pip` development
+
+```bash
+git clone https://github.com/todo-group/pypkg_template.git
+cd pypkg_template
+pip install pip -U
+pip install -e .[dev]
+```
+
+### `pipenv` development
+
 ```bash
 git clone https://github.com/todo-group/pypkg_template.git
 cd pypkg_template
 pip install pip -U
-# Simple installation
-# For development purpose, use `pip install -e .[dev]` instead.
-pip install -e .
+pip install pipenv
+pipenv install --dev
+pipenv shell
 ```

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,35 @@
+"""Sphinx configuration file."""  # noqa: INP001
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path("../../src").resolve()))
+
+project = "pypkg_template"
+copyright = "2022, SS"  # noqa: A001
+author = "SS"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+]
+
+# templates_path = ["_templates"]
+# exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+# html_static_path = ["_static"]

docs/source/index.rst

@@ -0,0 +1,15 @@
+.. pypkg_template documentation master file, created by
+   sphinx-quickstart on Sat Sep 28 03:33:47 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+pypkg_template documentation
+============================
+
+This is the documentation for the `pypkg_template` package.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules

docs/source/modules.rst

@@ -0,0 +1,7 @@
+pypkg_template
+==============
+
+.. toctree::
+   :maxdepth: 4
+
+   pypkg_template

docs/source/pypkg_template.rst

@@ -0,0 +1,21 @@
+pypkg\_template package
+=======================
+
+Submodules
+----------
+
+pypkg\_template.fibonacci module
+--------------------------------
+
+.. automodule:: pypkg_template.fibonacci
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pypkg_template
+   :members:
+   :undoc-members:
+   :show-inheritance: