Welcome to mini-project-2’s documentation!

This code is open source, and is available on GitHub.

mini-project-2

Build Status Documentation Status Code Coverage

Requirements

  • Python 3.6+

Overview

mini-project-2 is a…

TODO: finish

Installation

mini-project-2 can be installed from source by running:

pip install .

Within the same directory as mini-project-2’s setup.py file.

Usage

After installing mini-project-2’s additional usage help on starting mini-project-2 can be obtained by running the following console command:

mini-project-2 --help

Command Line Use

Start mini-project-2

usage: mini_project_2 [-h] [--log-level LOG_LEVEL] [--log-dir LOG_DIR] [-v]

Logging

--log-level

Set the logging output level

Default: INFO

--log-dir Enable TimeRotatingLogging at the directory specified
-v, --verbose

Enable verbose logging

Default: False

Indices and tables