https://github.com/astrojuanlu/copier-kedro

A copier template for Kedro projects
https://github.com/astrojuanlu/copier-kedro

Last synced: 17 days ago
JSON representation

A copier template for Kedro projects

• Host: GitHub
• URL: https://github.com/astrojuanlu/copier-kedro
• Owner: astrojuanlu
• License: mit
• Created: 2024-02-19T07:27:04.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-09-02T22:30:36.000Z (4 months ago)
• Last Synced: 2024-11-26T05:23:25.612Z (about 2 months ago)
• Language: Jinja
• Size: 94.7 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# copier-kedro

[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.

- [pytest] for testing.

- [tox] for automation of test runners and other stuff.

- [Sphinx] for documentation

- [GitHub Actions] for continuous integration and publishing to PyPI.

- [Read the Docs] for continuous documentation.

- [mypy] for type checks.

- [ruff] for style checks and automatic Python code formatting.

- [pre-commit] for optional automation of style checks.

- [PDM] as build backend.

## License

[MIT License](LICENSE)

[uv]: https://github.com/astral-sh/uv

[copier]: https://github.com/copier-org/copier/

[mypy]: http://mypy.readthedocs.io/

[PDM]: https://pdm-project.org/

[pytest]: https://docs.pytest.org/

[Sphinx]: http://www.sphinx-doc.org/

[tox]: https://tox.readthedocs.io/

[ruff]: https://docs.astral.sh/ruff/

[pre-commit]: https://github.com/pre-commit/pre-commit/

[GitHub Actions]: https://github.com/features/actions/

[Read the Docs]: https://readthedocs.org/