diff --git a/.cookiecutter-replay.json b/.cookiecutter-replay.json index 5b36730b..683c89c7 100644 --- a/.cookiecutter-replay.json +++ b/.cookiecutter-replay.json @@ -4,7 +4,7 @@ "type": "lib", "name": "client-common", "description": "Common code and utilities for Frequenz API clients", - "title": "Freqenz Client Common Library", + "title": "Frequenz Client Common Library", "keywords": "(comma separated: 'frequenz', and are included automatically)", "github_org": "frequenz-floss", "license": "MIT", diff --git a/.github/RELEASE_NOTES.template.md b/.github/RELEASE_NOTES.template.md index 76f209ff..92616f87 100644 --- a/.github/RELEASE_NOTES.template.md +++ b/.github/RELEASE_NOTES.template.md @@ -1,4 +1,4 @@ -# Freqenz Client Common Library Release Notes +# Frequenz Client Common Library Release Notes ## Summary diff --git a/.gitignore b/.gitignore index 6997f699..1e1f00e4 100644 --- a/.gitignore +++ b/.gitignore @@ -148,3 +148,9 @@ cython_debug/ # Automatically generated documentation docs/reference/ site/ + +# Auto-generated python files from the protocol buffer compiler +py/**/*_pb2.py +py/**/*_pb2.pyi +py/**/*_pb2_grpc.py +py/**/*_pb2_grpc.pyi diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4004334..6dee3893 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Freqenz Client Common Library +# Contributing to Frequenz Client Common Library ## Build diff --git a/README.md b/README.md index d14cd039..5fe425f1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Freqenz Client Common Library +# Frequenz Client Common Library [![Build Status](https://github.com/frequenz-floss/frequenz-client-common-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-client-common-python/actions/workflows/ci.yaml) [![PyPI Package](https://img.shields.io/pypi/v/frequenz-client-common)](https://pypi.org/project/frequenz-client-common/) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 76f209ff..92616f87 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,4 +1,4 @@ -# Freqenz Client Common Library Release Notes +# Frequenz Client Common Library Release Notes ## Summary diff --git a/docs/_scripts/macros.py b/docs/_scripts/macros.py index ff87c718..f84712e4 100644 --- a/docs/_scripts/macros.py +++ b/docs/_scripts/macros.py @@ -27,10 +27,7 @@ def _slugify(text: str) -> str: Returns: The slugified text. """ - # The type of the return value is not defined for the markdown library. - # Also for some reason `mypy` thinks the `toc` module doesn't have a - # `slugify_unicode` function, but it definitely does. - return toc.slugify_unicode(text, "-") # type: ignore[attr-defined,no-any-return] + return toc.slugify_unicode(text, "-") def _hook_macros_plugin(env: macros.MacrosPlugin) -> None: diff --git a/mkdocs.yml b/mkdocs.yml index 0cd87a0c..0e118e8b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ # For details see: https://www.mkdocs.org/user-guide/configuration/ # Project information -site_name: "Freqenz Client Common Library" +site_name: "Frequenz Client Common Library" site_description: "Common code and utilities for Frequenz API clients" site_author: "Frequenz Energy-as-a-Service GmbH" copyright: "Copyright © 2023 Frequenz Energy-as-a-Service GmbH" @@ -100,7 +100,6 @@ plugins: alias_type: redirect canonical_version: latest - mkdocstrings: - custom_templates: templates default_handler: python handlers: python: diff --git a/pyproject.toml b/pyproject.toml index 1f6e611b..800f75db 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ requires = [ "setuptools == 68.1.0", "setuptools_scm[toml] == 7.1.0", - "frequenz-repo-config[lib] == 0.7.5", + "frequenz-repo-config[lib] == 0.8.0", ] build-backend = "setuptools.build_meta" @@ -42,41 +42,41 @@ dev-flake8 = [ "flake8 == 6.1.0", "flake8-docstrings == 1.7.0", "flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml - "pydoclint == 0.3.2", + "pydoclint == 0.3.9", "pydocstyle == 6.3.0", ] -dev-formatting = ["black == 23.9.1", "isort == 5.12.0"] +dev-formatting = ["black == 23.9.1", "isort == 5.13.2"] dev-mkdocs = [ "black == 23.9.1", - "Markdown==3.4.4", + "Markdown==3.5.2", "mike == 2.0.0", "mkdocs-gen-files == 0.5.0", "mkdocs-literate-nav == 0.6.1", - "mkdocs-macros-plugin == 1.0.4", - "mkdocs-material == 9.3.1", - "mkdocstrings[python] == 0.23.0", - "frequenz-repo-config[lib] == 0.7.5", + "mkdocs-macros-plugin == 1.0.5", + "mkdocs-material == 9.5.6", + "mkdocstrings[python] == 0.24.0", + "frequenz-repo-config[lib] == 0.8.0", ] dev-mypy = [ - "mypy == 1.5.1", - "types-Markdown == 3.4.2.10", + "mypy == 1.8.0", + "types-Markdown == 3.5.0.20240129", # For checking the noxfile, docs/ script, and tests "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]", ] dev-noxfile = [ "nox == 2023.4.22", - "frequenz-repo-config[lib] == 0.7.5", + "frequenz-repo-config[lib] == 0.8.0", ] dev-pylint = [ - "pylint == 3.0.2", + "pylint == 3.0.3", # For checking the noxfile, docs/ script, and tests "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]", ] dev-pytest = [ "pytest == 7.4.2", - "frequenz-repo-config[extra-lint-examples] == 0.7.5", - "pytest-mock == 3.11.1", - "pytest-asyncio == 0.21.1", + "frequenz-repo-config[extra-lint-examples] == 0.8.0", + "pytest-mock == 3.12.0", + "pytest-asyncio == 0.23.4", "async-solipsism == 0.5", ] dev = [ @@ -126,6 +126,7 @@ min-similarity-lines = 40 [tool.pylint.messages_control] disable = [ "too-few-public-methods", + "too-many-return-statements", # disabled because it conflicts with isort "wrong-import-order", "ungrouped-imports",