pwrforge Documentation

This is the documentation for pwrforge - a Python-based C/C++ package and software development life cycle manager based on RUST cargo idea.

pwrforge can:

  • Create a new project (binary or library)

  • Build the project

  • Run code static analyzers

  • Fix chosen problem automatically base on the checker analysis

  • Run unit tests

  • Generate documentation from the source code

  • Work with a predefine docker environment depending on the chosen architecture

Quick Start

Getting started is easy:

  1. Install pwrforge:

    $ pip install pwrforge

    For detailed instructions, see Installation and Dependencies.

  2. Run pwrforge commands to create a new project:

    $ pwrforge new my_project_name

  3. Run pwrforge commands to check available options:

    $ pwrforge --help/-h

For Windows

  1. Install Python >=3.10 with pip from https://www.python.org/downloads/windows/

  2. Install Docker for Windows (e.g. https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe)

  3. Install pwrforge (pip install pwrforge) and add the program to your env paths

System Properties -> Environment Variables, double click on “Path” and add entry with your pwrforge installation e.g.

C:\Users\username\AppData\Roaming\Python\Python38\Scripts

For Ubuntu

  1. Install pwrforge (pip install pwrforge)

  2. If system does not find ‘pwrforge’ command add the installation directory to your env paths. You can find installation directory by running:
    $ find / -name "pwrforge"

    Then add it to the path, e.g.:

    $ export PATH=~/.local/bin:${PATH}

More Information