Metadata-Version: 2.1
Name: gitstery-generator
Version: 1.0.1
Summary: A Git murder mystery
Home-page: https://github.com/nivbend/gitstery-generator
Author: Niv Ben-David
Author-email: nivbend@gmail.com
License: GPLv3
Description: [![PyPI version](https://badge.fury.io/py/gitstery-generator.svg)](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 git@github.com: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
        * 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).
        
Keywords: git mystery learn learning
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Education
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: Terminals
Description-Content-Type: text/markdown
