Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 1012 Bytes

DEVELOP.md

File metadata and controls

40 lines (33 loc) · 1012 Bytes

Setting up a development environment

Quikey is written using Python 3.x, virtualenv, and setuptools. Ensure those prerequisites are available before proceeding. If anything more is needed or missing, please open up an issue and the team will be happy to help!.

Clone and setup

  1. Clone the repository
# git clone https://github.com/bostrt/quikey.git
# cd quikey
  1. Setup Python 3.x virtual environment
# virtualenv v
# source v/bin/activate
# python --version
Python 3.7.3
  1. Install dependencies and prepare scripts in development mode (editable)
# pip install --editable .
  1. Make sure you can run qk script:
# qk
Usage: qk [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.
...
  1. Finally, make your changes and submit a PR!

Running Tests

Tests can be run after following setup steps above and then executing:

# python setup.py test