Changelog#

To install the unreleased gp-libs version, see developmental releases.

pip:

$ pip install --user --upgrade --pre gp-libs

gp-libs 0.0.7 (unreleased)#

  • Add your latest changes from PRs here

Development#

  • Strengthen linting (#31)

    • Add flake8-commas (COM)

      • https://docs.astral.sh/ruff/rules/#flake8-commas-com

      • https://pypi.org/project/flake8-commas/

    • Add flake8-builtins (A)

      • https://docs.astral.sh/ruff/rules/#flake8-builtins-a

      • https://pypi.org/project/flake8-builtins/

    • Add flake8-errmsg (EM)

      • https://docs.astral.sh/ruff/rules/#flake8-errmsg-em

      • https://pypi.org/project/flake8-errmsg/

gp-libs 0.0.6post0 (2024-02-01)#

Packaging#

  • Relax pytest version constraint from 8+ to 7+ (#30)

gp-libs 0.0.6 (2024-02-01)#

Breaking change#

  • Support pytest >8 (#29)

    • Update doctest pytest plugin for pytest 8.

Development#

  • ruff 0.2.0

gp-libs 0.0.5 (2023-12-03)#

Maintenance release: no bug fixes or new features.

CI#

  • Move CodeQL from advanced configuration file to GitHub’s default

Development#

  • ci: Add pydocstyle rule to ruff (#28)

Documentation#

  • Add docstrings to functions, methods, classes, and packages (#28)

gp-libs 0.0.4 (2023-11-19)#

Development#

  • poetry: 1.6.1 -> 1.7.0

    See also: https://github.com/python-poetry/poetry/blob/1.7.0/CHANGELOG.md

  • Move formatting from black to ruff format (#27)

    This retains the same formatting style of black while eliminating a dev dependency by using our existing rust-based ruff linter.

  • CI: Update action packages to fix warnings

Packaging#

  • Add Python 3.12 to trove classifiers

  • Packaging (poetry): Fix development dependencies

    Per Poetry’s docs on managing dependencies and poetry check, we had it wrong: Instead of using extras, we should create these:

    [tool.poetry.group.group-name.dependencies]
    dev-dependency = "1.0.0"
    

    Which we now do.

gp-libs 0.0.3 (2023-10-14)#

Fixes#

doctest_docutils#

pytest_doctest_docutils#

  • pytest_collect_file: Typing fix (#25)

Development#

Packaging#

  • Move pytest configuration to pyproject.toml (#24)

gp-libs 0.0.2 (2023-09-09)#

Breaking changes#

  • Python 3.7 Dropped (#23)

gp-libs 0.0.1 (2023-09-09)#

  • Add your latest changes from PRs here

New features#

  • linkify_issues: Automatically link

    conf.py:

    issue_url_tpl = 'https://github.com/git-pull/gp-libs/issues/{issue_id}'
    
  • doctest_docutils: :mod:doctest w/ docutils support (and markdown)

  • doctest_docutils: Support for sphinx-inline-tab’s tab directive was added in v0.0.1a17 (#18)

    ````{tab} example tab
    
    ```python
    >>> 4 + 4
    8
    ```
    
    ````
    
    ````{tab} example second
    
    ```python
    >>> 4 + 2
    6
    ```
    
    ````
    

Removed features#

  • sphinx_toctree_autodoc_fix was removed in v0.0.1a12

    Overcome by Sphinx 5.2 bakes this in by default:

    Settings options:

    • add_function_parentheses = False (default: True)

    • toc_object_entries_show_parents can be (default: 'domain'):

      • toc_object_entries_show_parents = 'domain'

      • toc_object_entries_show_parents = 'hide'

      • toc_object_entries_show_parents = 'all'

    See also:

    • https://github.com/sphinx-doc/sphinx/issues/6316

    • https://github.com/sphinx-doc/sphinx/pull/10807

    • https://gist.github.com/agoose77/e8f0f8f7d7133e73483ca5c2dd7b907f

Documentation#

  • Initial docs, packaging, etc.

Tests#

pytest-doctest-docutils:

  • Add tests for pytest conftest.py files (#9)

Infrastructure#

  • Ruff (additional linting rules): Added in #20 and #21

  • CI: docutils testgrid (#16)

  • CI speedups (#13)

    • Split out release to separate job so the PyPI Upload docker image isn’t pulled on normal runs

    • Clean up CodeQL

  • Poetry: Bump 1.1.x to 1.6.x