Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# bot-python
Starter kit for Python bot for Automa

Please read the [Bot Development](https://docs.automa.app/bot-development) docs to understand how this bot works.
Please read the [Bot Development](https://docs.automa.app/bot-development) docs to understand how an [Automa][automa] bot works and how to develop it.

* `/automa` endpoint is the receiver for the webhook from [Automa](https://automa.app)
* `/automa` endpoint is the receiver for the webhook from [Automa][automa]
* `update` function in `app/update.py` is the logic responsible for updating code.
* `AUTOMA_WEBHOOK_SECRET` environment variable is available to be set instead of hard-coding it.

Expand Down Expand Up @@ -35,3 +35,6 @@ uv run pytest

* Uses [uv](https://docs.astral.sh/uv/) as a package manager.
* Uses [fastapi](https://fastapi.tiangolo.com/) as a server.
* Need [git](https://git-scm.org) to be installed in production.

[automa]: https://automa.app
8 changes: 7 additions & 1 deletion app/update.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
def update(folder: str):
from automa.bot import CodeFolder


def update(folder: CodeFolder):
"""
Update code in the specified folder.
"""

# If adding a new file, use the following:
# folder.add("example.py")
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ requires-python = ">=3.11"
classifiers = ["Private :: Do Not Upload"]

dependencies = [
"automa-bot~=0.1.4",
"automa-bot~=0.2.0",
"fastapi-cli~=0.0.7",
"fastapi~=0.115.11",
"pydantic-settings~=2.8.1",
"uvicorn~=0.34.0",
]

[dependency-groups]
dev = ["httpx~=0.28.1", "pytest-cov~=6.0.0", "pytest~=8.3.5", "ruff~=0.11.2"]
dev = ["httpx~=0.28.1", "pytest~=8.3.5", "ruff~=0.11.2"]

[tool.pytest.ini_options]
pythonpath = "."
Expand Down
Loading