magnopy#

The CLI commang magnopy can display information about the package or run its test suite.

Getting help#

We recommend to get the accurate and full list of script's parameters, that reflects installed version of Magnopy with the command

magnopy --help

which outputs to the standard output channel (console or terminal) Magnopy's metadata and full list of script's arguments. Here is an example of this output

Hint

Go here to learn how to read this help message.

usage: magnopy [-h] [-v] [command ...]

                #   #
                #####
                # # #
                # # #
                #####
                 ###
                 ###   #   #  ###   ###  #   #  ###  ####  #   #
                 ####  ## ## #   # #     ##  # #   # #   # ## ##
                 ####  # # # ##### #  ## # # # #   # ####   ###
                 ####  #   # #   # #   # #  ## #   # #       #
                 ####  #   # #   #  ###  #   #  ###  #       #
                 #############################################
                 ##                                         ##
                 ##             Version: 0.6.0              ##
                 ##       Release date: 18 June 2026        ##
                 ##                                         ##
                 ##           License: GNU GPLv3            ##
                 ##       Documentation: magnopy.org        ##
                 ##     Copyright (C) 2023 Magnopy Team     ##
                 ##                                         ##
                 #############################################

Available scripts are:

* magnopy-optimize-sd

* magnopy-lswt

To call for help for each script type <script name> --help
Information below is relevant only to 'magnopy' command.

positional arguments:
  command        command/commands on what to do. Use to display information
                 about Magnopy. Choose from 'logo', 'warranty', 'test'

options:
  -h, --help     show this help message and exit
  -v, --version  print version of Magnopy

Version#

To get the version of the Magnopy's installation, use

magnopy --version

which shall output something similar to

Magnopy version : 0.6.0
Release date    : ?? June 2026
Library path    : .venv/lib/python3.13/site-packages/magnopy

magnopy test#

To run the test suite of Magnopy, use

magnopy test

The runtime of the test suite depends on the hardware and can take several minutes. Progress is printed to the console.