https://github.com/botcity-dev/botcity-framework-base-python

BotCity Framework (Base) - Python
https://github.com/botcity-dev/botcity-framework-base-python

Last synced: about 1 month ago
JSON representation

BotCity Framework (Base) - Python

• Host: GitHub
• URL: https://github.com/botcity-dev/botcity-framework-base-python
• Owner: botcity-dev
• License: apache-2.0
• Created: 2021-07-01T23:58:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T16:22:43.000Z (6 months ago)
• Last Synced: 2024-10-30T15:56:05.651Z (about 2 months ago)
• Language: Python
• Homepage: https://botcity-dev.github.io/botcity-framework-base-python/
• Size: 1 MB
• Stars: 2
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
BotCity Framework Base - Python


  


    « Explore Framework docs »

    


    


    Report bug

    ·

    Request feature

    ·

    How to Contribute

    ·

    Support

  





# Prerequisites

* Python 3.7+

* Pillow

Python package requirements are listed in the requirements.txt file, which can

be used to install all requirements from pip: 'pip install -r requirements.txt'

# Running the Tests

In order to run the tests you will need to install some dependencies that are

not part of the runtime dependencies.

Assuming that you have cloned this repository do:

```bash

pip install -r test-requirements.txt

python run_tests.py

```

# Running the Examples

There are various examples of the features and how to get started.

Check out the examples folder.

# 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:

```bash

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

Documentation is available at https://botcity-dev.github.io/botcity-framework-base-python.