Skip to content

Commit

Permalink
Rework README
Browse files Browse the repository at this point in the history
  • Loading branch information
astrojuanlu committed Aug 27, 2024
1 parent e9c6c21 commit 7d8f1cd
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# copier-pylib
# copier-kedro

[Copier](https://github.com/copier-org/copier) template for pure Python libraries.
[Copier](https://github.com/copier-org/copier) template Kedro projects.

_As simple as possible. No magic._

## Usage

```
mkdir my-kedro-project && cd my-kedro-project
uvx copier copy --trust gh:astrojuanlu/copier-kedro .
```


(`uvx` is the shorthand for `uv tool run`, see [the uv documentation](https://docs.astral.sh/uv/guides/tools/))

## Features

- [uv] for project management.
Expand All @@ -17,20 +28,6 @@ _As simple as possible. No magic._
- [pre-commit] for optional automation of style checks.
- [PDM] as build backend.

## Usage

Install `copier`:

```
uv tool install copier
```

Generate a Python package:

```
copier copy gh:astrojuanlu/copier-pylib path/to/destination
```

## License

[MIT License](LICENSE)
Expand Down

0 comments on commit 7d8f1cd

Please sign in to comment.