Home

Welcome to the Input API Wiki!

This Wiki will go over the entirety of the Input API and how it can be used.

About the Input API

The Input API is a python package to aid user input in the terminal. Designed to be simple to use for beginners and allow more features for advanced users. The Input API can grab most data types, the exception being list-like data types. The Input API can take: strings, boolean, integers, and floats.

Installation

All of these install methods are Debian GNU/Linux specific, you may have to alter the commands for Windows or MacOS.

Recommended

Here is the recommended way of installing the Input API.

1. Create a virtual environment (optional)

python -m venv .venv

2. Use pip to install the package

python -m pip install inputapi

GitHub method #1

1. Download the .whl file from the latest release

2. Install the file using pip

python -m pip install Path/To/File.whl

GitHub Method #2

WARNING!!! this method is UNSTABLE and is not recommended

1. Run this command using pip

python -m pip install git+https://github.com/HomerHaddock/Input-API.git

Build and Install

1. Clone the repository

git clone https://github.com/HomerHaddock/Input-API.git

2. Prepare for building

cd Input-API
python -m venv .venv
source .venv/bin/activate
python -m pip install build

3. Build

python -m build

4. Install

python -m pip install dist/inputapi-*-py3-none-any.whl