Skip to main content

Grab recent issue/PR activity from a GitHub repository and render it as markdown.

Project description

github-activity

Generate simple markdown changelogs for GitHub repositories written in Python.

This package does two things:

  1. Given a GitHub org, repository, an initial git reference or date, use the GitHub GraphQL API to return a DataFrame of all issue and PR activity for this time period.
  2. A CLI to render this activity as markdown, suitable for generating changelogs or community updates.

Note: This is a really young tool so it might change a bit over time.

Installation

The easiest way to install this package is via pip:

pip install github-activity

Usage

The easiest way to use github-activity to generate activity markdown is to use the command-line interface. It takes the following form:

github-activity [<org>/<repo>] --since <date or ref> --until <date or ref>

See the github-activity documentation for more information.

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

github_activity-0.3.0.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

github_activity-0.3.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file github_activity-0.3.0.tar.gz.

File metadata

  • Download URL: github_activity-0.3.0.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for github_activity-0.3.0.tar.gz
Algorithm Hash digest
SHA256 99cbe1a817b3ad0bd0d90cdb76313809bf7dad29e7d06e01eb0b28c1adc3d0dd
MD5 7f4b1022dcd78921ecd6e37b6777ae48
BLAKE2b-256 4b3b82ccbc27ce0d697f957146f67ead9b7fd916d7784f37b70f7602e88385d1

See more details on using hashes here.

Provenance

File details

Details for the file github_activity-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for github_activity-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 468543e38358ec9387106644f1cb944dfed12ead7b9d6347d7a41d30a8d934e3
MD5 a0d164685692a6df67db97d24956f126
BLAKE2b-256 327527f70a662ed823f7b1463a649c3353ef8ceb1a14c5ebdc2415b4556f790b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page