Skip to content

Getting Started

Installation

Botstrap is published as a package on PyPI and can be easily installed using pip:

pip install -U botstrap

This will also automatically install compatible versions of Botstrap's dependencies (colorama and cryptography), so there's no need to install those packages separately.

Info - Python requirements

Botstrap requires a recent version of Python as well as the Python package manager, pip, to be installed on your system. You can check your currently-installed versions from the command line:

$ python --version
Python 3.10.8
$ pip --version
pip 22.3.1 from /usr/local/lib/python3.10/site-packages/pip (python 3.10)

For reference, Botstrap supports Python versions and the latest pip version is .

Note - Installing from source

Botstrap can alternatively be installed from GitHub by cloning its repository. This might be of interest if you want to use the very latest snapshot, or if you want to play with the code (and maybe make a contribution). 💜

To create a development installation of Botstrap in your current environment, use the following commands:

$ git clone https://github.com/nuztalgia/botstrap.git
$ cd botstrap
$ pip install -e . # (1)!
  1. Using the -e flag produces an editable installation. (Make sure you include the . in the command!)