Regenerate repository using repo-config

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

.cookiecutter-replay.json

@@ -0,0 +1,36 @@
+{
+  "cookiecutter": {
+    "Introduction": "",
+    "type": "lib",
+    "name": "dispatch-client",
+    "description": "Dispatch API client for Python",
+    "title": "Frequenz Dispatch Client Library",
+    "keywords": "dispatch, client, api, python",
+    "github_org": "frequenz-floss",
+    "license": "MIT",
+    "author_name": "Frequenz Energy-as-a-Service GmbH",
+    "author_email": "[email protected]",
+    "python_package": "frequenz.client.dispatch",
+    "pypi_package_name": "frequenz-dispatch-client",
+    "github_repo_name": "frequenz-client-dispatch-python",
+    "default_codeowners": "@frequenz-floss/api-dispatch-team",
+    "_template": "gh:frequenz-floss/frequenz-repo-config-python",
+    "_repo_dir": "/home/marenz/.cookiecutters/frequenz-repo-config-python/cookiecutter"
+  },
+  "_cookiecutter": {
+    "Introduction": "]\n\n    Welcome to repo-config Cookiecutter template!\n\n    This template will help you to create a new repository for your project.     You will be asked to provide some information about your project.\n\n    Here is an explanation of what each variable is for and will be used for:\n\n    * `type`: The type of repository. It must be chosen from the list.\n\n* `name`: The name of the project. This will be used to build defaults for\n  other inputs, such as `title`, `python_package`, etc. It should be one word,\n  using only alphanumeric characters (and starting with a letter). It can\n  include also `_` and `-` which will be handled differently when building\n  other variables from it (replaced by spaces in titles for example).\n\n* `description`: A short description of the project. It will be used as the\n  description in the `README.md`, `pyproject.toml`, `mkdocs.yml`, etc.\n\n* `title`: A human-readable name or title for the project. It will be used in\n  the `README.md`, `CONTRIBUTING.md`, and other files to refer to the project,\n  as well as the site title in `mkdocs.yml`.\n\n* `keywords`: A comma-separated list of keywords that will be used in the\n  `pyproject.toml` file. If left untouched, it will use only some predefined\n  keywords. If anything else is entered, it will be **added** to the default\n  keywords.\n\n* `github_org`: The GitHub handle of the organization where the project will\n  reside. This will be used to generate links to the project on GitHub.\n\n* `license`: Currently, only two options are provided: `MIT`, which should be\n  used for open-source projects, and `Proprietary`, which should be used for\n  closed-source projects. This will be added to file headers and used as the\n  license in `pyproject.toml`.\n\n* `author_name`, `author_email`: The name and email address of the author of\n  the project. They will be used in the copyright notice in file headers and\n  as the author in `pyproject.toml`.\n\n* `python_package`: The Python package in which this project will reside. All\n  files provided by this project should be located in this package. This needs\n  to be a list of valid Python identifiers separated by dots. The source file\n  structure will be derived from this. For example, `frequenz.actor.example`\n  will generate files in `src/frequenz/actor/example`.\n\n* `pypi_package_name`: The name of the PyPI/wheel/distribution package. This\n  should be consistent with the `python_package`, usually replacing `.` with\n  `-`. For example, `frequenz-actor-example`.\n\n* `github_repo_name`: The handle of the GitHub repository where the project\n  will reside. This will be used to generate links to the project on GitHub and\n  as the top-level directory name.\n\n* `default_codeowners`: A space-separated list of GitHub teams (`@org/team`) or\n  users (`@user`) that will be the default code owners for this project. This\n  will be used to build the `CODEOWNERS` file. Please refer to the [code owners\n  documentation] for more details on the valid syntax.\n\n[code owners documentation]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners\n\n\n    [Please press any key to continue",
+    "type": "lib",
+    "name": "dispatch-client",
+    "description": "Dispatch API client for Python",
+    "title": "Frequenz Dispatch Client Library",
+    "keywords": "dispatch, client, api, python",
+    "github_org": "frequenz-floss",
+    "license": "MIT",
+    "author_name": "Frequenz Energy-as-a-Service GmbH",
+    "author_email": "[email protected]",
+    "python_package": "frequenz.client.dispatch",
+    "pypi_package_name": "frequenz-dispatch-client",
+    "github_repo_name": "frequenz-client-dispatch-python",
+    "default_codeowners": "@frequenz-floss/api-dispatch-team"
+  }
+}

.editorconfig

@@ -0,0 +1,26 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Set default charset, indent style and trimming of whitespace
+[{.editorconfig,CODEOWNERS,LICENSE,*.{in,json,md,proto,py,pyi,toml,yaml,yml}}]
+charset = utf-8
+indent_style = space
+trim_trailing_whitespace = true
+
+# 4 space indentation
+[*.{py,pyi}]
+indent_size = 4
+
+# 2 space indentation
+[{.editorconfig,CODEOWNERS,LICENSE,*.{in,json,proto,toml,yaml,yml}}]
+indent_size = 2
+
+# No indentation size specified for *.md because different blocks have
+# different indentation rules

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,66 @@
+# GitHub issue form. For more information see:
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Report something is not working properly 🐛
+description:
+  Use this if there is something that is not working properly.  If you are not
+  sure or you need help making something work, please ask a question instead.
+labels:
+  - "priority:❓"
+  - "type:bug"
+body:
+  - type: markdown
+    attributes:
+      value:
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Please tell us what happened that shouldn't have.
+      placeholder: What happened that shouldn't have.
+    validations:
+      required: true
+  - type: textarea
+    id: what-expected
+    attributes:
+      label: What did you expect instead?
+      description: Please tell us what did you expect to happen.
+      placeholder: What did you expect to happen.
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Affected version(s)
+      description:
+        Please add a comma-separated list of the versions affected by this
+        issue.
+      placeholder: 'Example: v0.11.0, v0.12.0'
+  - type: dropdown
+    id: part
+    attributes:
+      label: Affected part(s)
+      description:
+        Which parts of the repo are affected by this issue? Select all that
+        apply.
+      multiple: true
+      options:
+        - I don't know (part:❓)
+        - Documentation (part:docs)
+        - Unit, integration and performance tests (part:tests)
+        - Build script, CI, dependencies, etc. (part:tooling)
+        # TODO(cookiecutter): Add other parts
+        # Please have in mind that that the part:xxx labels need to
+        # be created in the GitHub repository.
+    validations:
+      required: true
+  - type: textarea
+    id: extra
+    attributes:
+      label: Extra information
+      description:
+        Please write here any extra information you think it might be relevant,
+        e.g., if this didn't happen before, or if you suspect where the problem
+        might be.
+      placeholder: Any extra information you think it might be relevant.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,10 @@
+# GitHub issue template chooser. For more information see:
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+
+blank_issues_enabled: true
+contact_links:
+  - name: Ask a question ❓
+    url: https://github.com/frequenz-floss/frequenz-client-dispatch-python/discussions/new?category=support
+    # TODO(cookiecutter): Make sure the GitHub repository has a discussion category "Support"
+    # Rename the "Q&A" category to "Support" and change the emoji to 🆘 (SOS)
+    about: Use this if you are not sure how to do something, have installation problems, etc.

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,61 @@
+# GitHub issue form. For more information see:
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Request a feature or enhancement ✨
+description: Use this if something is missing or could be done better or more easily.
+labels:
+  - "part:❓"
+  - "priority:❓"
+  - "type:enhancement"
+body:
+  - type: markdown
+    attributes:
+      value:
+        Thanks for taking the time to fill out this feature or enhancement
+        request!
+  - type: textarea
+    id: whats-needed
+    attributes:
+      label: What's needed?
+      description:
+        Please tell us what's missing or what could be done better or more easily.
+      placeholder: What's missing or what could be done better or more easily.
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed solution
+      description:
+        Please tell us how you think the needs above can be fulfilled. Only
+        fill this field if it wasn't described above.
+      placeholder:
+        How do you think the needs above can be fulfilled. Only fill this field
+        if it wasn't described above.
+  - type: textarea
+    id: use-cases
+    attributes:
+      label: Use cases
+      description:
+        Please tell us about the main use cases you see for this new feature or
+        enhancement to help us understand more.
+      placeholder:
+        The main use cases you see for this new feature or enhancement to help
+        us understand more.
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives and workarounds
+      description:
+        Please tell us if you tried any alternatives or workarounds for these
+        use cases and how (un)useful they were.
+      placeholder:
+        Any alternatives or workarounds for these use cases and how (un)useful
+        they were.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description:
+        Please add any additional information here - screenshots, diagrams, etc.
+      placeholder: Any additional information here - screenshots, diagrams, etc.

.github/RELEASE_NOTES.template.md

@@ -0,0 +1,17 @@
+# Frequenz Dispatch Client Library Release Notes
+
+## Summary
+
+<!-- Here goes a general summary of what this release is about -->
+
+## Upgrading
+
+<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+
+## New Features
+
+<!-- Here goes the main new features and examples or instructions on how to use them -->
+
+## Bug Fixes
+
+<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

.github/containers/nox-cross-arch/arm64-ubuntu-20.04-python-3.11.Dockerfile

@@ -0,0 +1,33 @@
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+# This Dockerfile is used to run the tests in arm64, which is not supported by
+# GitHub Actions at the moment.
+
+FROM docker.io/library/ubuntu:20.04
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install Python 3.11 and curl to install pip later
+RUN apt-get update -y && \
+    apt-get install --no-install-recommends -y \
+        software-properties-common && \
+    add-apt-repository ppa:deadsnakes/ppa && \
+    apt-get install --no-install-recommends -y \
+        ca-certificates \
+        curl \
+        git \
+        python3.11 \
+        python3.11-distutils && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+# Install pip
+RUN curl -sS https://bootstrap.pypa.io/get-pip.py | python3.11
+
+RUN update-alternatives --install \
+        /usr/local/bin/python python /usr/bin/python3.11 1 && \
+    python -m pip install --upgrade --no-cache-dir pip
+
+COPY entrypoint.bash /usr/bin/entrypoint.bash
+
+ENTRYPOINT ["/usr/bin/entrypoint.bash"]

.github/containers/nox-cross-arch/entrypoint.bash

@@ -0,0 +1,9 @@
+#!/bin/bash
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+set -e
+
+echo "System details:" $(uname -a)
+echo "Machine:" $(uname -m)
+
+exec "$@"

.github/containers/test-installation/Dockerfile

@@ -0,0 +1,12 @@
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+# This Dockerfile is used to test the installation of the python package in
+# multiple platforms in the CI. It is not used to build the package itself.
+
+FROM --platform=${TARGETPLATFORM} python:3.11-slim
+
+RUN python -m pip install --upgrade --no-cache-dir pip
+
+COPY dist dist
+RUN pip install dist/*.whl && \
+    rm -rf dist

.github/dependabot.yml

@@ -0,0 +1,41 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+      day: "monday"
+    labels:
+      - "part:tooling"
+      - "type:tech-debt"
+    # Default versioning-strategy. For other versioning-strategy see:
+    # https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#versioning-strategy
+    versioning-strategy: auto
+    # Allow up to 10 open pull requests for updates to dependency versions
+    open-pull-requests-limit: 10
+    # We group production and development ("optional" in the context of
+    # pyproject.toml) dependency updates when they are patch and minor updates,
+    # so we end up with less PRs being generated.
+    # Major updates are still managed, but they'll create one PR per
+    # dependency, as major updates are expected to be breaking, it is better to
+    # manage them individually.
+    groups:
+      required:
+        dependency-type: "production"
+        update-types:
+          - "minor"
+          - "patch"
+      optional:
+        dependency-type: "development"
+        update-types:
+          - "minor"
+          - "patch"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+      day: "monday"
+    labels:
+      - "part:tooling"
+      - "type:tech-debt"

.github/keylabeler.yml

@@ -0,0 +1,21 @@
+# KeywordLabeler app configuration. For more information check:
+# https://github.com/ZeWaka/KeywordLabeler#readme
+
+# Determines if we search the title (optional). Defaults to true.
+matchTitle: true
+
+# Determines if we search the body (optional). Defaults to true.
+matchBody: true
+
+# Determines if label matching is case sensitive (optional). Defaults to true.
+caseSensitive: true
+
+# Explicit keyword mappings to labels. Form of match:label. Required.
+labelMappings:
+  "part:docs": "part:docs"
+  "part:tests": "part:tests"
+  "part:tooling": "part:tooling"
+  "part:❓": "part:❓"
+  # TODO(cookiecutter): Add other parts
+  # Please have in mind that that the part:xxx labels need to
+  # be created in the GitHub repository.

.github/labeler.yml

@@ -0,0 +1,51 @@
+# Configuration for the Labeler GitHub action, executed by
+# .github/workflows/labeler.yml.
+#
+# The basic syntax is [label]: [path patterns].
+#
+# For more details on the configuration please see:
+# https://github.com/marketplace/actions/labeler
+
+# TODO(cookiecutter): Add different parts of the source
+# For example:
+#
+# "part:module":
+#   - "src/frequenz/lib/dispatch_client/module/**"
+#
+# "part:other":
+#   - "src/frequenz/lib/dispatch_client/other/**"
+#
+# # For excluding some files (in this example, label "part:complicated"
+# # everything inside src/ with a .py suffix, except for src/__init__.py)
+# "part:complicated":
+#   - any:
+#       - "src/**/*.py"
+#   - all:
+#       - "!src/__init__.py"
+#
+# Please have in mind that that the part:xxx labels need to
+# be created in the GitHub repository.
+
+"part:docs":
+  - "**/*.md"
+  - "docs/**"
+  - "examples/**"
+  - LICENSE
+
+"part:tests":
+  - "**/conftest.py"
+  - "tests/**"
+
+"part:tooling":
+  - "**/*.ini"
+  - "**/*.toml"
+  - "**/*.yaml"
+  - "**/*.yml"
+  - "**/conftest.py"
+  - ".editorconfig"
+  - ".git*"
+  - ".git*/**"
+  - "docs/*.py"
+  - CODEOWNERS
+  - MANIFEST.in
+  - noxfile.py