Getting Started

Prerequisites

Before installing PyPluginizer, ensure that you have the following prerequisites met:

• Python: PyPluginizer requires Python 3.6 or higher to run. Make sure Python is installed on your system.

Installation

To install PyPluginizer, you'll need to checkout the source and create a virtual environment:

$ git clone https://github.com/cbabil/PyPluginizer.git
$ cd PyPluginizer
$ make venv
$ source .venv/bin/activate
$ make setup

This will:

• Clone the PyPluginizer repo to your local system
• Setup PyPluginizer python virtual environment
• Activate the PyPluginizer virtual environment
• Install python dependencies

Running the demo

To run the demo application:

make run

Running the unit tests

To run the unit tests using pytest:

make test

Cleaning up

Before running make clean, make sure to deactivate the virtual environment:

deactivate
make clean

This will:

• Deactivate PyPluginizer virtual environment
• Remove log files
• Remove pyc files
• Remove test files such as cache and coverage
• Remove pre-commit file
• Remove virtual environment