Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.18 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.18 KB

kedro-init

Documentation Status Code style: ruff-format PyPI

A simple CLI command that initialises a Kedro project from an existing Python package

Installation

To install, run

(.venv) $ pip install "kedro-init @ https://github.com/astrojuanlu/kedro-init.git"

Usage

For example, from a Poetry package:

(.venv) $ poetry new --src test-project && cd test-project
(.venv) $ kedro-init .
[00:19:38] Looking for existing package directories                             cli.py:25
[00:19:45] Initialising config directories                                      cli.py:25
           Creating modules                                                     cli.py:25
           🔶 Kedro project successfully initialised!                           cli.py:26

Development

To run style checks:

(.venv) $ pip install pre-commit
(.venv) $ pre-commit run -a