pvman 0.1.0a1

PVM analysis like you never seen before.

pvman

PVM analysis like you never seen before

---

POWERED BY

:sunrise_over_mountains: Purpose & Function

pvman is a Python library to perform advanced Price-Volume-Mix analysis using the novel PVM-MPQ method. It aims to provide a clean API to enable programmatic analysis via Python scripts or being embedded in downstream applications, as well as offer a terminal user interface to provide users with a utility to analyse their datasets on the fly.

:star_struck: Standout Features

We are currently in the Planning stage of the project, still defining the scope of the first milestones and our development plan. However, we anticipate the following features to be delivered for users at some point in the future:

• :technologist: A back-end API to make PVM analysis as easy to perform as manipulating pandas DataFrames;
• :gem: A polished front-end interface to do PVM analysis live and navigation features with power users in mind;
• :children_crossing: A tutorial mode to easily onboard users on the concepts of PVM and how to use pvman.

:inbox_tray: Installation

Use pipx to install pvman in an isolated environment:

pipx install pvman

Then you can run it from the command line:

pvman --help

:black_joker: How to Use It

The top-level command is the entry point for additional operations:

pvman [--version | -v]

--version

-v

Print the current version of the program and exit.

Launch the Interface

Launch the terminal interface with the pvman launch command:

pvman launch [(--config | -c) <file>]

--config

-c

Specify a custom configuration file to launch the application.

Manage the Configuration

The pvman config command provides additional subcommands to manipulate the settings for your pvman installation:

pvman config get [--path <file>] [--secret | -s] KEY

KEY

The configuration key to be retrieved. [required]

--path

Specify a custom configuration file.

--secret

-s

Retrieve configuration from the secret manager instead.

pvman config set [--path <file>] [--secret | -s] KEY VALUE

KEY

The configuration key to be retrieved. [required]

VALUE

The value to be stored with the key. [required]

--path

Specify a custom configuration file.

--secret

-s

Store configuration in the secret manager instead.

pvman config extend [--path <file>] [--secret | -s] [--create-on-missing | -c] KEY VALUE

KEY

The configuration key to be extended. [required]

VALUE

The value to be appended to the key. [required]

--path

Specify a custom configuration file.

--secret

-s

Store configuration in the secret manager instead.

--create-on-missing

-c

Add the provided value in an array if the setting is not set. Will raise an error otherwise.

pvman config unset [--path <file>] [--secret | -s] KEY

KEY

The configuration key to be removed. [required]

--path

Specify a custom configuration file.

--secret

-s

Retrieve configuration from the secret manager instead.

:reminder_ribbon: Contributing

There are several ways to contribute to pvman. Refer to our CONTRIBUTING guide for all relevant details.

Currently, we are seeking help to tackle areas of focus that are more pressing to our project's progress and would make an immediate difference in helping us achieve our mission.

Here are some key contributions your can help us with right now:

• Provide input in design discussions to define the desired features of pvman.

:ship: Releases

You can see the list of available releases on the GitLab Releases page.

We follow Intended Effort Versioning specification, details can be found in our CONTRIBUTING guide.

:shield: Licence

This project is licenced under the terms of the GNU Affero General Public License v3.0 or later. See LICENCE for more details.

:page_with_curl: Citation

We provide a CITATION.cff file to make it easier to cite this project in your paper.

Credits

This project was generated with Galactipy.