purex 0.1.1

PuReX - Pull Request eXtractor

Installation

Using pip:

pip install purex

Using uv (recommended):

uv add purex

To install the documentation, you can install purex[doc] instead of purex.

Tutorials

First thing to do after the installation, is to set the environment variable token. This token is your GitHub token that will be used for sending the requests to GitHub REST API. Although including the token is not necessary, but it can be helpful for a faster extraction, specially for bigger projects.

In UNIX-like (GNU/Linux, Mac OS) operating systems:

export PUREX_TOKEN="YOUR TOKEN"

In Windows operating system:

set PUREX_TOKEN="YOUR_TOKEN"

For getting help about the PuReX, you can run it without any extra command or just pass the help option:

purex --help

Usage: purex [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  get  Get pull-request data of a repository.

Getting Data from a Repository

purex get --help

Usage: purex get [OPTIONS] OWNER REPOSITORY

  GET pull-request data for REPOSITY from OWNER.

  OWNER is the account name that hosts the repository (e.g., torvalds).

  REPOSITORY is the name of the repository (e.g., linux).

Options:
  -t, --token TEXT         GitHub Token
  -u, --base_url TEXT      REST API url of GitHub.
  --start_date [%m-%d-%Y]  Inclusive starting date (MM-DD-YYYY) for pulling
                           the pull-request data.
  --help                   Show this message and exit.

For more info and tutorials, please refer to the documentation.

About

Publications

If you use PuReX in your research, please cite it as follows:

@software{PuReX,
  author = {Mokhtari Koushyar, Javad},
  doi = {10.5281/zenodo.15825844},
  month = {2},
  title = {{PuReX, Pull-Request Extractor}},
  url = {https://github.com/j0m0k0/PuReX},
  year = {2025}
}