{"author":"","author_email":"","bugtrack_url":null,"classifiers":["Development Status :: 3 - Alpha","License :: OSI Approved :: BSD License","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.9"],"description":"# changelist\n\nA tool that automates release note generation.\n\nFor example, see\nhttps://github.com/scientific-python/changelist/blob/main/CHANGELOG.md.\n\n**Features**\n\n- Compile a list of pull requests, code authors, and reviewers between\n two given git commits.\n- Categorize pull requests into sections based on GitHub labels.\n- Override pull request titles with more descriptive summaries.\n- Document unrelated changes in a pull requests in separate summaries.\n\n_This project is currently in its alpha stage and might be incomplete or change a lot!_\n\n## Installation\n\n```sh\npip install changelist\n```\n\n## Usage\n\nThe script requires a [GitHub personal access\ntoken](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).\nThe token does not need any permissions, since it is used only to\nincrease query limits.\n\n```sh\nexport GH_TOKEN='...'\nchangelist scientific-python/changelist v0.2.0 main\n```\n\nThis will list all pull requests, authors and reviewers that touched commits\nbetween `v0.2.0` and `main` (excluding `v0.2.0`).\nPull requests are sorted into sections according to the configuration in\n`tool.changelist.label_section_map`.\n\n## Writing pull request summaries\n\nBy default, changelist will fall back to the title of a pull request and its\nGitHub labels to sort it into the appropriate section. However, if you want\nlonger summaries of your changes you can add a code block with the following\nform anywhere in the description of the pull request:\n\n ```release-note\n An ideally expressive description of the change that is included as\n a single bullet point. Newlines are removed.\n ```\n\nSometimes pull requests introduce multiple changes that should be listed in different\nsections. For that reason, a summary block like above can be used more than\nonce. Additionally, you can add independent labels to each summary by adding a\n`{label=\"...\"}` anywhere in the summary. These labels are sorted the same way\nas regular pull request labels are. E.g. the two summaries below will go into\nseparate sections:\n\n ```release-note {label=\"Bug fix\"}\n Make `is_odd()` work for negative numbers.\n ```\n\n ```release-note\n Deprecate `ìs_odd`; use `not (x % 2)` instead! {label=\"API, Highlight\"}\n ```\n\n## Configuration\n\nchangelist can be configured from two sources, in order of precedence:\n\n- A local TOML file specified with the `--config` option\n- A remote `pyproject.toml` at `stop_rev`\n\nIf a configuration option is not specified in either file above, changelist\nfalls back to the following configuration:\n\n\n\n\n````toml\n# Default changelist configuration as supported in pyproject.toml\n[tool.changelist]\n\n# A template string that is included as the title of the generated notes.\n# \"{repo_name}\" and \"{version}\", if given, are replaced by the respective\n# values given in the command line.\ntitle_template = \"{repo_name} {version}\"\n\n# A template string that is included as introductory text after the title.\n# \"{repo_name}\" and \"{version}\", if given, are replaced by the respective\n# values given in the command line.\nintro_template = \"\"\"\nWe're happy to announce the release of {repo_name} {version}!\n\"\"\"\n\n# A template string that is included at the end of the generated notes.\n# \"{repo_name}\" and \"{version}\", if given, are replaced by the respective\n# values given in the command line.\noutro_template = \"\"\"\n_These lists are automatically generated, and may not be complete or may contain\nduplicates._\n\"\"\"\n\n# Profiles that are excluded from the contributor list.\nignored_user_logins = [\n \"web-flow\",\n]\n\n# If this regex matches a pull requests description, the captured content\n# is included instead of the pull request title. E.g. the\n# default regex below is matched by\n#\n# ```release-note\n# An ideally expressive description of the change that is included as\n# a single bullet point. Newlines are removed.\n# ```\n#\n# If you modify this regex, make sure to match the content with a capture\n# group named \"summary\". The regex is allowed to match more than once in which\n# case a single pull request may result in multiple items (see\n# `pr_summary_label_regex` for why that might be useful).\npr_summary_regex = \"^```release-note\\\\s*(?P

[\\\\s\\\\S]*?\\\\w[\\\\s\\\\S]*?)\\\\s*^```\"\n\n# Sometimes pull requests introduce changes that should be listed in different\n# sections. For that reason, `pr_summary_regex` can match more than once and\n# this regex, `pr_summary_label_regex`, can be used to add independent labels\n# to each summary. These labels are sorted with the `label_section_map` the\n# same way as regular pull request labels are. E.g. the example below will both\n# match and go into separate sections:\n#\n# ```release-note {label=\"Bug fix\"}\n# Make `is_odd()` work for negative numbers.\n# ```\n#\n# ```release-note\n# Deprecate `ìs_odd`; use `not (x % 2)` instead! {label=\"API, Highlight\"}\n# ```\n#\n# If you modify this regex, make sure to match the content with a capture\n# group named \"label\".\npr_summary_label_regex = \"\"\"{[^}]*?label=[\\\\\"](?P[^\\\\\"]+)[^}]*?}\"\"\"\n\n# If any of a pull request's labels matches one of the regexes on the left side\n# its summary will appear in the appropriate section with the title given on\n# the right side. If a pull request doesn't match one of these categories it is\n# sorted into a section titled \"Other\". Pull request can appear in multiple\n# sections as long as their labels match.\n[tool.changelist.label_section_map]\n\".*Highlight.*\" = \"Highlights\"\n\".*New feature.*\" = \"New Features\"\n\".*API.*\" = \"API Changes\"\n\".*Enhancement.*\" = \"Enhancements\"\n\".*Performance.*\" = \"Performance\"\n\".*Bug fix.*\" = \"Bug Fixes\"\n\".*Documentation.*\" = \"Documentation\"\n\".*Infrastructure.*\" = \"Infrastructure\"\n\".*Maintenance.*\" = \"Maintenance\"\n````\n\n\n\n## Set up your repository\n\nTo categorize merged PRs in the changelist with the default configuration, each\nPR must have a label that matches one of the regexes on the left side of the\n`label_section_map` table, e.g. `type: Highlights`.\n\n### Label checking\n\nYou may want to ensure that each PR has an associated `type: ` label,\nwe recommend adding an action that fails CI if the label is missing.\n\nTo do so, place the following in `.github/workflows/label-check.yaml`:\n\n\n\n\n```yaml\nname: Labels\n\non:\n pull_request:\n types:\n - opened\n - reopened\n - labeled\n - unlabeled\n - synchronize\n\nenv:\n LABELS: ${{ join( github.event.pull_request.labels.*.name, ' ' ) }}\n\njobs:\n check-type-label:\n name: ensure type label\n runs-on: ubuntu-latest\n steps:\n - if: \"contains( env.LABELS, 'type: ' ) == false\"\n run: exit 1\n```\n\n\n\n### Milestones\n\nOften, it is helpful to have milestones that reflect the actual PRs\nmerged. We therefore recommend adding an action that attached the\nnext open milestone to any merged PR.\n\nTo do so, place the following in `.github/workflows/milestone-merged-prs.yaml`:\n\n\n\n\n```yaml\nname: Milestone\n\non:\n pull_request_target:\n types:\n - closed\n branches:\n - \"main\"\n\njobs:\n milestone_pr:\n name: attach to PR\n runs-on: ubuntu-latest\n steps:\n - uses: scientific-python/attach-next-milestone-action@bc07be829f693829263e57d5e8489f4e57d3d420\n with:\n token: ${{ secrets.MILESTONE_LABELER_TOKEN }}\n force: true\n```\n\n\n\nSee https://github.com/scientific-python/attach-next-milestone-action for more information.\n","description_content_type":"text/markdown","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"","keywords":"","license":"BSD 3-Clause License Copyright (c) 2023, Scientific Python Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"changelist","package_url":"https://pypi.org/project/changelist/","platform":null,"project_url":"https://pypi.org/project/changelist/","project_urls":{"Source":"https://github.com/scientific-python/changelist"},"provides_extra":null,"release_url":"https://pypi.org/project/changelist/0.5/","requires_dist":["requests","requests-cache","tqdm","PyGithub","pre-commit ==3.6.0 ; extra == 'lint'","pytest ; extra == 'test'","pytest-cov ; extra == 'test'"],"requires_python":">=3.9","summary":"","version":"0.5","yanked":false,"yanked_reason":null}

Dependency	Optional
PyGithub	false
requests	false
requests-cache	false
tqdm	false
pre-commit	true
pytest	true
pytest-cov	true

Package search

changelist

project_urls

Dependencies

All package metadata

Releases