Get Started
Installation
To use Ampalibe, first install it using pip:
$ pip install ampalibe
if you use mysql as database, you have to install mysql-connector or mysql-connector-python with ampalibe
$ pip install ampalibe[mysql-connector]
OR
$ pip install ampalibe[mysql-connector-python]
Creation of a new project
After installation, an ampalibe
executable is available in your system path,
and we will create our project with this command.
Important
command-line ampalibe
is ampalibe.bat
for Windows
$ ampalibe create myfirstbot
There will be a created directory named myfirstbot/ and all the files contained in it.
Note
You can directly create project without a new directory with init command
$ cd myExistingDirectory
$ ampalibe init
Understanding of files
|
Important
.env file is env.bat in Windows
Before starting
How to complete the environment variable file
|
Run the app
In the project folder, type
$ ampalibe run
for dev mode with Hot Reload
$ ampalibe run --dev
INFO: Started server process [26753]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://0.0.0.0:4555 (Press CTRL+C to quit)
Note
Ampalibe use uvicorn to run server, so it is an output of uvicorn
You will need to configure a Facebook application, a Facebook page, get the access to the page, link the application to the page, configure a webhook for your app before you can really start using __Ampalibe__.
This app setup guide should help
OR
See this video on Youtube