Skip to content

Commit

Permalink
Rework template README
Browse files Browse the repository at this point in the history
  • Loading branch information
astrojuanlu committed Aug 27, 2024
1 parent d4c99eb commit dd8f82e
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions template/README.md.j2
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
# {{ project_name }}

[![Documentation Status](https://readthedocs.org/projects/{{ project_name }}/badge/?version=latest)](https://{{ project_name }}.readthedocs.io/en/latest/?badge=latest)
![Powered by Kedro](https://img.shields.io/badge/powered_by-kedro-ffc900?logo=kedro)
[![Code style: ruff-format](https://img.shields.io/badge/code%20style-ruff_format-6340ac.svg)](https://github.com/astral-sh/ruff)
[![PyPI](https://img.shields.io/pypi/v/{{ project_name }})](https://pypi.org/project/{{ project_name }})

{{ short_description}}
Add a longer description here.

## Installation
## How to run your Kedro pipeline

To install, run
You can run your Kedro project with:

```
$ uv pip install {{ project_name }}
uv run kedro run
```

## Development
## How to test your Kedro project

To run style checks:
Have a look at the file `tests/test_run.py` for instructions on how to write your tests. You can run your tests as follows:

```
$ uv tool install pre-commit
$ pre-commit run -a
uv run pytest
```

## Overview
## Project dependencies

Add a longer description here.
To see and update the dependency requirements for your project, use `uv`.

0 comments on commit dd8f82e

Please sign in to comment.