Skip to main content

A simple CLI command that generate a Kedro project from a cookiecutter template in the current directory

Project description

kedrogen

PyPI Python Versions License Build Documentation Status Code style: ruff-format Ruff

A simple CLI command that generate a Kedro project from a cookiecutter template in the current directory.

Installation

pip install kedrogen

Usage

$ kedrogen [OPTIONS] TEMPLATE

Arguments:

  • TEMPLATE_PATH: Specify the template to use when creating the project. This can be the path to a local directory, a URL to a remote VCS repository supported by cookiecutter or path to either a local or remote zip file. [required]

Options:

  • -c, --checkout TEXT: The branch, tag or commit ID to checkout after clone.
  • -d, --directory TEXT: An optional directory inside the repository to use as the template, that is, the directory within the repository where cookiecutter.json lives.
  • -p, --password TEXT: The password to use when extracting a password protected zipfile
  • -vv, --verbose: Enable verbose output to show detailed progress and debug information.
  • -q, --quiet: Suppress all non-error messages.
  • -v, --version: Show the version and exit.
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • -h, --help: Show this message and exit.

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

kedrogen was created by Shafayet Khan Shafee. It is licensed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kedrogen-0.3.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kedrogen-0.3.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file kedrogen-0.3.0.tar.gz.

File metadata

  • Download URL: kedrogen-0.3.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kedrogen-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d7c537ac93b82320fcc8725db5e153d8b6bf7bada24b0305a94bd456fae98634
MD5 3ff41957855f00db3226c62f0c039e91
BLAKE2b-256 5344dc7ae45fc64a68fbbf4e4d1617526d872d1ebdddb281f16cf971a57d4ddb

See more details on using hashes here.

File details

Details for the file kedrogen-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: kedrogen-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kedrogen-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2750087e92ab39d0c61b8818fe9eb52bf7f9bf1c0cbd05df0f5db75ee067f904
MD5 b509412851052d7e3860c80f75bafa0d
BLAKE2b-256 1b6c7d9bb29e6fbe6e471efec7b097820b1c5d7d62ae21652fba462438e98529

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page