| Name | kedrogen JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | A simple CLI command that generate a Kedro project from a cookiecutter template in the current directory |
| upload_time | 2025-07-12 19:50:25 |
| maintainer | None |
| docs_url | None |
| author | Shafayet Khan Shafee |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
cli
kedro
cookiecutter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# kedrogen
[](https://pypi.org/project/kedrogen/)   [](https://github.com/shafayetShafee/kedrogen/actions/workflows/ci-cd.yml) [](https://kedrogen.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/astral-sh/ruff) [](https://github.com/astral-sh/ruff)
A simple CLI command that generate a Kedro project from a cookiecutter template in the current directory.
## Installation
```console
pip install kedrogen
```
## Usage
```console
$ 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "kedrogen",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "cli, kedro, cookiecutter",
"author": "Shafayet Khan Shafee",
"author_email": "sshafee@isrt.ac.bd",
"download_url": "https://files.pythonhosted.org/packages/53/44/dc7ae45fc64a68fbbf4e4d1617526d872d1ebdddb281f16cf971a57d4ddb/kedrogen-0.3.0.tar.gz",
"platform": null,
"description": "# kedrogen\n\n[](https://pypi.org/project/kedrogen/)   [](https://github.com/shafayetShafee/kedrogen/actions/workflows/ci-cd.yml) [](https://kedrogen.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/astral-sh/ruff) [](https://github.com/astral-sh/ruff)\n\nA simple CLI command that generate a Kedro project from a cookiecutter template in the current directory.\n\n## Installation\n\n```console\npip install kedrogen\n```\n \n## Usage\n\n```console\n$ kedrogen [OPTIONS] TEMPLATE\n```\n\n**Arguments**:\n\n* `TEMPLATE_PATH`: Specify the template to use when creating the project.\nThis can be the path to a local directory, a URL to a remote VCS repository supported\nby `cookiecutter` or path to either a local or remote zip file.\n [required]\n\n**Options**:\n\n* `-c, --checkout TEXT`: The branch, tag or commit ID to checkout after clone.\n* `-d, --directory TEXT`: An optional directory inside the repository to use as the template, that is,\nthe directory within the repository where cookiecutter.json lives.\n* `-p, --password TEXT`: The password to use when extracting a password protected zipfile\n* `-vv, --verbose`: Enable verbose output to show detailed progress and debug information.\n* `-q, --quiet`: Suppress all non-error messages.\n* `-v, --version`: Show the version and exit.\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `-h, --help`: Show this message and exit.\n\n\n## Contributing\n\nInterested 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.\n\n## License\n\n`kedrogen` was created by Shafayet Khan Shafee. It is licensed under the terms of the MIT license.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple CLI command that generate a Kedro project from a cookiecutter template in the current directory",
"version": "0.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/shafayetShafee/kedrogen/issues",
"Documentation": "https://github.com/shafayetShafee/kedrogen/blob/main/README.md",
"Repository": "https://github.com/shafayetShafee/kedrogen"
},
"split_keywords": [
"cli",
" kedro",
" cookiecutter"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1b6c7d9bb29e6fbe6e471efec7b097820b1c5d7d62ae21652fba462438e98529",
"md5": "b509412851052d7e3860c80f75bafa0d",
"sha256": "2750087e92ab39d0c61b8818fe9eb52bf7f9bf1c0cbd05df0f5db75ee067f904"
},
"downloads": -1,
"filename": "kedrogen-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b509412851052d7e3860c80f75bafa0d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8142,
"upload_time": "2025-07-12T19:50:24",
"upload_time_iso_8601": "2025-07-12T19:50:24.484519Z",
"url": "https://files.pythonhosted.org/packages/1b/6c/7d9bb29e6fbe6e471efec7b097820b1c5d7d62ae21652fba462438e98529/kedrogen-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5344dc7ae45fc64a68fbbf4e4d1617526d872d1ebdddb281f16cf971a57d4ddb",
"md5": "3ff41957855f00db3226c62f0c039e91",
"sha256": "d7c537ac93b82320fcc8725db5e153d8b6bf7bada24b0305a94bd456fae98634"
},
"downloads": -1,
"filename": "kedrogen-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "3ff41957855f00db3226c62f0c039e91",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6564,
"upload_time": "2025-07-12T19:50:25",
"upload_time_iso_8601": "2025-07-12T19:50:25.356172Z",
"url": "https://files.pythonhosted.org/packages/53/44/dc7ae45fc64a68fbbf4e4d1617526d872d1ebdddb281f16cf971a57d4ddb/kedrogen-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-12 19:50:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shafayetShafee",
"github_project": "kedrogen",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kedrogen"
}
