Metadata-Version: 2.1
Name: github_activity
Version: 0.3.0
Summary: Grab recent issue/PR activity from a GitHub repository and render it as markdown.
Home-page: https://jupyter.org/
Author: Executable Books Project
Author-email: choldgraf@berkeley.edu
License: BSD
Keywords: development changelog
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: testing
Provides-Extra: sphinx
License-File: LICENSE

# 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](https://developer.github.com/v4/) 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](https://github-activity.readthedocs.io)
for more information.
