Skip to content

Latest commit

 

History

History
41 lines (34 loc) · 1.37 KB

File metadata and controls

41 lines (34 loc) · 1.37 KB

FlowForge

Table of Contents

  1. Installation Instructions
  2. Developer Tools
  3. Contributing

Installation Instructions

Installing flowforge using the following instructions will install the package along with the required dependencies.

End User Installation

This will change to PyPI installation once flowforge is open source.

python -m pip install .

Developer Installation

python3 -m pip install -e .[dev]

Testing Installation (Primarily for CI)

python -m pip install .[test]

Developer Tools

The configuration settings for the developer tools can be found in ~/FlowForge/pyproject.toml.

Linting Python code with pylint

Execute this line from the ~/FlowForge directory to lint the code with pylint:

pylint ./flowforge

Formatting code with black

Execute this line from the ~/FlowForge directory to automatically format the code to PEP8 standard using black:

black ./flowforge

Contributing

FlowForge is distributed under the terms of the BSD 3-Clause license. If you propose or make a contribution to this repository, you hereby license your contribution to anyone under this same license.