README.md

# Overview
Python utility for ensuring that projects maintain the same settings, configurations, files, etc. Designed to be used in conjuction with built-in GitLab project templates.

# Usage
This utility is written in Python 3 and can be executed via the following:

`python3 template.py --gitlab-url="https://repo1.dsop.io" --gitlab-token="mytoken" --template-project=1979 `

## Arguments
Argument | Description | Default
--- | --- | ---
gitlab-url | The URL of Gitlab | None
gitlab-token | The access token used when communcating with the Gitlab instance | None
template-project | The project within Gitlab to use as the template | None

## Requirements
The base application requires the following Python 3 modules to be installed:
- `requests`
- `getopt`
- `sys`
- `logging`

Additional Python 3 modules may be necessary based on which modules are enabled within this project.

# Modules
You may view the necessary documentation on each the following modules by cicking on it's name:
- [file_templates](docs/file_templates.md)
- [branches](docs/branches.md)
- [badges](docs/badges.md)