Installation

kumaone (kumaone) requires Python 3.9 or above. If you do not already have a Python environment configured on your computer, please see the Python page for instructions on installing Python environment.

Assuming that the default python environment is already configured on your computer, and you intend to install kumaone in it, to create and work with Python virtual environments, please follow instructions from pipenv.

To start the installation process, please make sure the latest version of pip (python3 package manager) is installed. If pip is not installed, please refer to the Pip documentation and install pip first.

Linux/macOS

Install the latest release of kumaone with pip:

pip install kumaone

To upgrade to a newer version use the --upgrade flag:

pip install --upgrade kumaone

If system-wide installation is not possible for permission reasons, use --user flag to install kumaone for current user

pip install --user kumaone

Windows

Considering python3 is installed and pip is configured.

Open Cmder/ConEmu and Type:

pip install kumaone

Or if the pipenv shell is active

pipenv install kumaone

This should install kumaone with all the required dependencies.

Install from Source

Alternatively, kumaone can be installed manually by downloading the current version from GitHub or PyPI. To install a downloaded versions, please unpack it in a preferred directory and run the following command at the top level of the directory:

pip install .

Dependencies

This package requires a configuration file in .yaml format. The look-up priority for the configuration file is as following-

  1. <user_home_directory>/.config/kumaone/kuma.yaml (Window/Linux/MacOS) [Default]

  2. <user_home_directory>/kuma.yaml (Windows/Linux/MacOS)

  3. <current_working_directory>/kuma.yaml (Windows/Linux/MacOS)

  4. /etc/<package_name>/kuma.yaml (Linux/MacOS)

If kuma.yaml doesn’t exists in one of these locations, the program will prompt for creating a new config. Alternatively you can provide a custom location for kumaone config. Find out more with

kumaone config create --help

Tip

It’s recommended to leave the config file creation at one of the location above. This way while using kumaone, user doesn’t have to provide custom config path everytime with -c or --config flag.

Windows

Windows system, by default doesn’t allow creation of . prefixed directory from GUI, so use the following -

  • Open cmd and change the directory to the home folder of the user

  • Run mkdir .config (if the folder doesn’t exist)

  • Run cd .config

  • Run mkdir kumaone

Now that the . prefixed directory is created use the following command to create the config file.

kumaone config create

Linux/MacOS

kumaone config create

Note

Example config files can be found under examples directory in kumaone GitHub repository.