Quick Start Guide

Install the package

Since this package is live on PyPI, you can install it via Python's pip utility:

$ pip install jutils

You can verify the installation and version of this package by viewing the package's information:

$ pip show jutl

Use the package in Python

Once you've installed the package via pip, you can import it in Python:

import jutl

Package import methods

There are a few different ways you can import packages in Python. This package is no different. jutils is designed to be as accessible as possible. Thus, extra care was taken to elevate relevant utilities to the submodule level. This means you don't have to drill down through the module's directories to find the tool you're looking for. 🎉

Method 1: Module import

import jutl
jutl.utilities.hello_world()

This method requires you to drill down through the module's directory to call the utility you need.

Note This method is currently being worked on.

Method 2: Submodule import

from jutl import utilities
utilities.hello_world()

This method allows you to access the utility more easily via the submodule's namespace.

Method 3: Utility import

from jutl.utilities import hello_world()
hello_world()

As the directory structures vary between submodules, you may find yourself using different syntax to access the tools you need. I've put together this help-guide to assist you in your import statements. You'll also find the optimal import statement on each utility's wiki page.