Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nivbend/gitstery-generator
Generate a Git Murder mystery
https://github.com/nivbend/gitstery-generator
git learning learning-by-doing mystery
Last synced: about 2 months ago
JSON representation
Generate a Git Murder mystery
- Host: GitHub
- URL: https://github.com/nivbend/gitstery-generator
- Owner: nivbend
- License: gpl-3.0
- Created: 2020-03-06T16:09:30.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T10:19:05.000Z (8 months ago)
- Last Synced: 2024-10-31T11:19:29.907Z (3 months ago)
- Topics: git, learning, learning-by-doing, mystery
- Language: Python
- Size: 279 KB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/gitstery-generator)
# 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
```
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
* English:
* List of given names: [Social Security's top 1000 names for 2018](https://www.ssa.gov/OACT/babynames/).
* List of surnames: [2000 US Census](https://www.census.gov/topics/population/genealogy/data/2000_surnames.html)
# Acknowledgments
The "murder mystery" repository this project generates was inspired by similar projects:
* [SQL Murder Mystery](https://mystery.knightlab.com/).
* [The Command Line Murders](https://github.com/veltman/clmystery).