Skip to main content

Dinghy daily digest tool

Project description

Dinghy, a GitHub activity digest tool.

PyPI Supported Python versions License Sponsor me on GitHub nedbat on Twitter

Dinghy uses the GitHub GraphQL API to find recent activity on issues and pull requests, and writes a compact HTML digest like this.

Getting Started

  1. Install dinghy:

    $ python -m pip install dinghy
    
  2. To run dinghy you will need a GitHub personal access token with the correct scopes, probably “repo”. Create one and define the GITHUB_TOKEN environment variable with the value:

    $ export GITHUB_TOKEN=ghp_Y2oxDn9gHJ3W2NcQeyJsrMOez
    
  1. Then run dinghy with a GitHub URL:

    $ python -m dinghy https://github.com/Me/MyProject
    Wrote digest: digest.html
    

    You will have a digest of the repo’s last week of activity in digest.html. It will look something like this.

    You can also write a YAML configuration file to digest multiple sources, or with different time periods.

Configuration

Dinghy configuration is read from a YAML file (dinghy.yaml by default). Here’s an example:

digests:
  - digest: lastweek.html
    since: 1 week
    items:
      - https://github.com/orgs/myorg/projects/17
      - https://github.com/orgs/anotherorg/projects/8
      - https://github.com/myorg/myrepo/pulls

  - digest: hotnews.html
    since: 1 day
    items:
      - url: https://github.com/orgs/anotherorg/projects/8
        home_repo: anotherorg/wg
      - https://github.com/myorg/churnchurn/issues

  - digest: all_prs.html
    since: 1 day
    items:
      - search: org:myorg is:pr
        title: MyOrg pull requests

defaults:
  ignore_users:
    - app-user
    - fake-bot

The digests clause is a list of digests to produce. The defaults clause sets defaults for the digest options in the rest of the file. Each digests clause specifies what to digest:

  • The digest setting is the HTML digest file to write.
  • The since setting indicates how far back to look for activity. It can use units of weeks, days, hours, minutes and seconds, and can also be abbreviated, like 1d6h.
  • The items setting is a list of things to report on, specified in a few different ways:
    • The url setting is a GitHub URL, in a number of forms:
      • An organization project URL will report on the issues and pull requests in the project. Your GitHub token will need the “read:org” scope.
      • A URL to a repo will report on the issues and pull requests in the repo.
      • A URL to a repo’s issues will report on the issues in the repo.
      • A URL to a repo’s pull requests will report on the pull requests in the repo.
      • Any of these URLs can point to a GitHub Enterprise installation instead of https://github.com.
    • The search setting can specify a GitHub search query to find issues or pull requests. The query will have an updated: term added to it to account for the since: setting.
    • If an item only needs to specify a GitHub URL, then it can simply be the URL string.

Items can have additional options:

  • No activity is reported for bot users. Some applications act as real users, but should be ignored anyway. You can list those user names that should be ignored in the ignore_users setting.
  • Items can have an explicit title set with the title: setting.
  • Options for organization projects include:
    • home_repo is the owner/repo of the repo in which most issues will be created. Issues in other repos will have the repo indicated in the digest.

Changelog

Unreleased

See the fragment files in the scriv.d directory.

0.11.4 — 2022-05-10

Added

  • HTML escaping is applied to the text pulled from GitHub (oops!)
  • Emojis are displayed as emojis rather than as text.

0.11.3 — 2022-05-06

Fixed

  • GitHub sometimes responds with “502 Bad Gateway”. Pause and retry if that happens.

0.11.2 — 2022-04-12

Added

  • Added a --version option.

Fixed

  • Pull requests with many reviews would skip some reviews. Now all pull request data is fully retrieved.
  • On large digests, GitHub sometimes returns 403 as a rate limit. Retry when this happens to finish the queries.

0.11.1 — 2022-03-29

Fixed

  • Corrected a packaging mistake (missing Changelog entry).

0.11.0 — 2022-03-29

Added

  • Resolved comments are now indicated with a checkbox icon, and hover text of “resolved comment”.

Fixed

  • Fixed a crash trying to get the repository for an issue in a project.

0.10.0 — 2022-03-28

Changed

  • Pull request data was not properly displayed: comments weren’t included in the digest that should have been.
  • Pull request comments older than the cutoff date will be included if they are needed to show the discussion threads of newer comments. The old comments are shown in gray to help stay focused on recent activity.
  • Parsing of time durations was made stricter, so that “1 month” isn’t mistaken for “1 minute”. Fixes issue 7

Removed

  • Oops, it turns out there’s no such thing as a repo project for “Projects (beta)”. That thing that wouldn’t have worked has been removed.

0.9.0 — 2022-03-17

Added

  • GitHub enterprise support: you can use URLs pointing to your own GitHub Enterprise installation. Only a single host can be used. Thanks, Henry Gessau.
  • A “search:” entry in the configuration file will find issues or pull requests matching the query.
  • Items in the configuration file can have title: to set an explicit title.

Deprecated

  • The pull_requests: configuration setting is deprecated in favor of search:. pull_requests: org:my_org becomes search: org:my_org is:pr.

0.8.0 — 2022-03-16

Added

  • Repo projects are supported.

Fixed

  • Error handling failed on certain errors. This is now fixed, closing issue 4.

0.7.1 — 2022-03-13

Fixed

  • Better handling of authorization problems, with error message presented so that the user can fix them.

0.7.0 — 2022-03-12

Added

  • The command line now accepts a GitHub URL to quickly get a week’s digest of activity from a repo (or issues, pull requests, etc).
  • The logging level can now be specified with the -v/--verbosity command-line option.

Fixed

  • Dependencies now have minimum pins, fixing issue 1.

0.6.0 — 2022-03-10

Added

  • GitHub’s @ghost user shows up in GraphQL results as an “author” of None. Properly handle that case.

Fixed

  • Fixes to the color of labels.
  • Correct handling of HTML in bodies.

0.5.2 — 2022-03-08

Changed

  • More HTML tweaks to indentation and information.

0.5.1 — 2022-03-07

Changed

  • Indentation tweaks to make thread structure clearer.

0.5.0 — 2022-03-03

Changed

  • Pull request reviews are displayed more compactly.

0.4.0 — 2022-02-28

Added

  • A repo URL will report on both pull requests and issues in the repo.

0.3.0 — 2022-02-27

Added

  • The configuration file can be specified as the argument on the command line.
  • GitHub icons decorate pull requests, issues, and comments to distinguish them and indicate their status.

Changed

  • The configuration file syntax changed. Now there is a top-level digests clause and an optional defaults clause.
  • The bots setting is now called ignore_users.
  • Pull request review threads are presented hierarchically.

0.2.0 — 2022-02-21

Added

  • Items can have options. Organization projects have a home_repo option so that issues from other repos will get an indication of the other repo.
  • Organizatons can be searched for pull requests.
  • If dinghy hits a GraphQL API rate limit, it will sleep until the limit is reset.
  • Don’t report on activity by bot users. The bot setting can be used to list user accounts that should be considered bots.

0.1.0 — 2022-02-19

  • First release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dinghy-0.11.4.tar.gz (37.5 kB view hashes)

Uploaded source

Built Distribution

dinghy-0.11.4-py2.py3-none-any.whl (30.7 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page