Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 1.52 KB

README.rst

File metadata and controls

87 lines (52 loc) · 1.52 KB

## Thermos CLI

A flask command line interface built on python.

## Note

If you wish to collaborate,visit https://github.com/mwangi-njuguna/thermos-cli or https://github.com/zecollokaris/Thermos-cli

## Prerequisites

Both the CLI and generated project have dependencies that require python3.6.

## Table of Contents

  • [Installation](#installation)
  • [Usage](#usage)
  • [Generating a New Flask Application](#Generating a new flask project)
  • [Generating Templates and Blueprints](#Generating templates and blueprints)
  • [Documentation](#documentation)
  • [License](#license)

## Installation

BEFORE YOU INSTALL: please make sure you have python3.6 installed.

`bash pip install -e . `

## Usage

`bash thermos --help `

### Generating a Flask Project

`bash thermos create app PROJECT-NAME `

### Generating Templates and Blueprints

You can use the thermos create app APPNAME to create a new application structure:

```bash thermos create template TEMPLATENAME

# Navigate into the new app cd NAMEOFAPP

# if in the directory src/app/nameofapp/ and you run thermos create blueprint BLUEPRINTNAME

```

### Working with master

`bash git clone https://github.com/zecollokaris/Thermos-cli cd thermos-cli pip install -e . `

pip install -e . will install this cli.

Now you can use thermos-cli via the command line:

```bash

thermos create

thermos -h | --help

thermos -v | --version

```

## Documentation

The documentation for the thermos CLI is located in this repo's [wiki](https://github.com/gnhkjm/).

## License

MIT