Setup Local Development Tool#

[TOC]

Prerequisites#

Setup project root poetry envinroment for development tools#

$ pwd

/.../ask-astro

$ python --version

Python 3.11.x

# install poetry (https://python-poetry.org/docs/#installation)
$ python -m pip install poetry
$ poetry install

list_tasks

Documentation Tasks#

  • Build sphinx docs

docs.build

  • Serve the docs locally (http://127.0.0.1:8000)

docs.serve

  • Generate the screenshot for help message on each tasks

docs.generate-tasks-help-screenshot

Apache Airflow® DAGs Tasks#

  • Run ask-astro airflow

airflow.run

  • Stop ask-astro airflow

airflow.stop

Backend API Tasks#

UI Tasks#

Run linters#

  • Run pre-commit checks

run-pre-commit