Template Bot Project - Python

« Explore Project docs »

Report bug · Request feature · How to Contribute · Support

Prerequisites

• Python 3.7+
• cookiecutter

Getting Started

This repository contains a cookiecutter template for generating a Bot using BotCity's Python Framework.

To create a templated project all you need to do is:

cookiecutter https://github.com/botcity-dev/bot-python-template

Building the Documentation Locally

In order to build the documentation you will need to install some dependencies that are not part of the runtime dependencies.

Assuming that you have cloned this repository do:

pip install -r docs-requirements.txt

mkdocs build

This will generate the HTML documentation in the <>/site folder. Look for the index.html file and open it with your browser.

Online Documentation

More information about cookiecutter and how to organize your Bot project can be found at https://botcity-dev.github.io/bot-python-template/.