💬 Mimic

Mimic mimics the style of a given corpus, for great fun and delight.

Developer Installation

We use pipenv for dependency management.

git clone https://github.com/ubclaunchpad/mimic.git
cd mimic/
pip install pipenv
pipenv install --dev

pipenv will manage a virtualenv, so interacting with the program or using the development tools has to be done through pipenv, like so:

pipenv run pycodestyle .

This can get inconvenient, so you can instead create a shell that runs in the managed environment like so:

pipenv shell

and then commands like pycodestyle and pytest can be run like normal.

Additionally, we use Travis CI as a CI system. To run the same checks locally, we provide scripts/build_check.sh; this can be run with:

./scripts/build_check.sh

Server

To start the server:

$ export FLASK_APP=index.py
$ flask run --without-threads
  Running on http://127.0.0.1:5000/

if on windows powershell, export using:

PS C:\path\to\app> $env:FLASK_APP = "index.py"