Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 1.84 KB

README.md

File metadata and controls

52 lines (43 loc) · 1.84 KB

PyPI version

The Git Murder Mystery Generator

This project generates a "gitstery" git repository.

NOTICE: This is not the Git Murder Mystery repository. For that, please visit https://github.com/nivbend/gitstery.

Install

pip install gitstery-generator

Or clone this repository and then pip install ./python setup.py install.

Usage

To generate a new repository at /tmp/gitstery:

gitstery generate /tmp/gitstery

To verify a repository:

gitstery verify /tmp/gitstery
gitstery verify https://github.com/nivbend/gitstery.git
gitstery verify [email protected]:nivbend/gitstery.git

If you have your own fork of the gitstery repository you'd like to update:

gitstery push /tmp/gitstery <your repository URL>

Or:

gitstery generate --push /tmp/gitstery

The following environment variables replace some commonly used values:

Environment Variable Usage
GITSTERY_TEMP_DIR The directory in which to generate the new repository
GITSTERY_SEED The random seed to use (useful for reproducible "builds")
GITSTERY_TARGET_REPO URL of the remote repository

Data

Acknowledgments

The "murder mystery" repository this project generates was inspired by similar projects: