From 199ef4be4d5be411eb34c42f8aeae0e3ded52c4a Mon Sep 17 00:00:00 2001 From: Jayaram Kancherla Date: Sun, 8 Dec 2024 06:44:48 -0800 Subject: [PATCH 1/4] chore: remove Python 3.8 support --- .github/workflows/pypi-publish.yml | 4 ++-- .github/workflows/pypi-test.yml | 2 +- CHANGELOG.md | 5 +++++ docs/conf.py | 9 +++++++++ docs/requirements.txt | 3 ++- setup.cfg | 2 +- 6 files changed, 20 insertions(+), 5 deletions(-) diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml index 7b591a2..cc1d1fb 100644 --- a/.github/workflows/pypi-publish.yml +++ b/.github/workflows/pypi-publish.yml @@ -14,10 +14,10 @@ jobs: steps: - uses: actions/checkout@v2 - - name: Set up Python 3.9 + - name: Set up Python 3.11 uses: actions/setup-python@v2 with: - python-version: 3.9 + python-version: 3.11 - name: Install dependencies run: | python -m pip install --upgrade pip diff --git a/.github/workflows/pypi-test.yml b/.github/workflows/pypi-test.yml index 9dc019a..31b7875 100644 --- a/.github/workflows/pypi-test.yml +++ b/.github/workflows/pypi-test.yml @@ -15,7 +15,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ] + python-version: [ '3.9', '3.10', '3.11', '3.12', '3.13' ] name: Python ${{ matrix.python-version }} steps: diff --git a/CHANGELOG.md b/CHANGELOG.md index d8f5fa2..cf60c6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## Version 0.6.0 + +- chore: Remove Python 3.8 (EOL). +- precommit: Replace docformatter with ruff's formatter. + ## Version 0.5.0 - SQLAlchemy session management diff --git a/docs/conf.py b/docs/conf.py index 23e20af..38fc05a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,6 +72,7 @@ "sphinx.ext.ifconfig", "sphinx.ext.mathjax", "sphinx.ext.napoleon", + "sphinx_autodoc_typehints", ] # Add any paths that contain templates here, relative to this directory. @@ -169,6 +170,14 @@ def setup(app): # If this is True, todo emits a warning for each TODO entries. The default is False. todo_emit_warnings = True +autodoc_default_options = { + 'special-members': True, + 'undoc-members': False, + 'exclude-members': '__weakref__, __dict__, __str__, __module__, __annotations__' +} + +autosummary_generate = True +autosummary_imported_members = True # -- Options for HTML output ------------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt index 0aec8ef..daecbf1 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,5 +3,6 @@ furo # To build the module reference correctly, make sure every external package # under `install_requires` in `setup.cfg` is also listed here! # sphinx_rtd_theme -recommonmark +myst-parser[linkify] sphinx>=3.2.1 +sphinx-autodoc-typehints diff --git a/setup.cfg b/setup.cfg index 55ad6f5..60b83e4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -39,7 +39,7 @@ package_dir = =src # Require a min/specific Python version (comma-separated conditions) -# python_requires = >=3.8 +python_requires = >=3.9 # Add here dependencies of your project (line-separated), e.g. requests>=2.2,<3.0. # Version specifiers like >=2.2,<3.0 avoid problems due to API changes in From b6ea67ab88bc0acbd710973d99f1ddc26c0906fc Mon Sep 17 00:00:00 2001 From: Jayaram Kancherla Date: Sun, 8 Dec 2024 06:55:15 -0800 Subject: [PATCH 2/4] bump action versions --- .github/workflows/pypi-publish.yml | 4 ++-- .github/workflows/pypi-test.yml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml index cc1d1fb..030cd10 100644 --- a/.github/workflows/pypi-publish.yml +++ b/.github/workflows/pypi-publish.yml @@ -13,9 +13,9 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Python 3.11 - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: 3.11 - name: Install dependencies diff --git a/.github/workflows/pypi-test.yml b/.github/workflows/pypi-test.yml index 31b7875..22f6c4a 100644 --- a/.github/workflows/pypi-test.yml +++ b/.github/workflows/pypi-test.yml @@ -19,9 +19,9 @@ jobs: name: Python ${{ matrix.python-version }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Setup Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} cache: 'pip' From 88ab70fac0353175d6819e4002a8c9799cbafdb1 Mon Sep 17 00:00:00 2001 From: Jayaram Kancherla Date: Thu, 19 Dec 2024 16:46:47 -0800 Subject: [PATCH 3/4] update changelog and add ruff documentor settings --- CHANGELOG.md | 2 +- pyproject.toml | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cf60c6f..f9083c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## Version 0.6.0 +## Version 0.5.5 - chore: Remove Python 3.8 (EOL). - precommit: Replace docformatter with ruff's formatter. diff --git a/pyproject.toml b/pyproject.toml index a7cea75..00aa968 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,6 +16,10 @@ extend-ignore = ["F821"] [tool.ruff.pydocstyle] convention = "google" +[tool.ruff.format] +docstring-code-format = true +docstring-code-line-length = 20 + [tool.ruff.per-file-ignores] "__init__.py" = ["E402", "F401"] From e7abdf3654b0d931d43dcf123d2476ffcef45f6e Mon Sep 17 00:00:00 2001 From: Jayaram Kancherla Date: Thu, 19 Dec 2024 16:48:24 -0800 Subject: [PATCH 4/4] add recommonmarkg --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index daecbf1..e1619a4 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,6 +3,6 @@ furo # To build the module reference correctly, make sure every external package # under `install_requires` in `setup.cfg` is also listed here! # sphinx_rtd_theme -myst-parser[linkify] +recommonmark sphinx>=3.2.1 sphinx-autodoc-typehints