Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

79 lines (50 loc) · 1.88 KB
Raw

Contributing - Setting up development

Note: Everything in this readme and project assumes python 3

Requirements

  • Install python3
  • Install pip (you probably don't have to)
  • Install virtualenv pip install virtualenv or sudo apt install python3-virtualenv Install make: sudo apt install make (linux). xcode-select --install (mac) Note: In macos is probable you have to run pip using sudo depending on your setup

Setup

  • Clone this repo
  • Setup and activate the virtualenv
  • Install the project dependencies

Note: Do not use sudo for any of the following commands

Run make setup to setup dependencies

make setup

Activate the virtualenv for the project

Inside the project:

. env/bin/activate

When you are done with development you can deactivate the venv with

deactivate

You should now be able to run kibbe in your terminal.

Run

To run the tool

python3 kibbe.py

or simply

./kibbe.py

Linting and formatting

This project uses black and flake8 for formatting and linting. Make sure your editor has these tools installed and running.

Releasing

To release a new version, you need to push a new incremental tag. That will trigger an auto-build and release.

There's a handy script to automate this process in scripts/increment-version.sh and you can use make to invoke it:

Minor release: make minor-release Major release: make major-relase

Problems

The first time you activate the virtualenv, you may need to run the following commands to install dev dependencies:

pip install psutil
python setup.py develop

Attempting to install development packages can result in a "SandboxViolation" error when it attempts to install psutil. If you install psutil first, you will avoid the error.