mvondracek/PA193_mnemonic_Slytherin

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# BIP39 Mnemonic Phrase Generator and Verifier

[![Build Status](https://travis-ci.org/mvondracek/PA193_mnemonic_Slytherin.svg?branch=dev)](https://travis-ci.org/mvondracek/PA193_mnemonic_Slytherin)
[![Coverage Status](https://coveralls.io/repos/github/mvondracek/PA193_mnemonic_Slytherin/badge.svg)](https://coveralls.io/github/mvondracek/PA193_mnemonic_Slytherin)
[![Maintainability](https://api.codeclimate.com/v1/badges/2fced9c80af313478661/maintainability)](https://codeclimate.com/github/mvondracek/PA193_mnemonic_Slytherin/maintainability)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)

> [Secure Coding Principles and Practices (PA193)](https://is.muni.cz/course/fi/autumn2019/PA193?lang=en)\
> [Faculty of Informatics (FI)](https://www.fi.muni.cz/index.html.en)\
> [Masaryk University (MU)](https://www.muni.cz/en)

**Team** Slytherin: [@sobuch](https://github.com/sobuch),
[@lsolodkova](https://github.com/lsolodkova),
[@mvondracek](https://github.com/mvondracek).

## Install & Uninstall

Install the package from its root folder, where `setup.py` is.

~~~sh
pip install .
~~~

~~~sh
pip uninstall pa193mnemonicslytherin
~~~

## Usage

Please see built-in help by calling `mnemoniccli --help`.

## Development

For development purposes, install the package and CLI tool using
`pip install -e .` in the root package folder. Please see
development guidelines in [CONTRIBUTING.md](/CONTRIBUTING.md).

## FUZZING

Before you start fuzzing install the package and also radamsa.

~~~sh
cd fuzz ; ./install.sh
~~~