| Name | base-template-cli JSON |
| Version |
3.0.2
JSON |
| download |
| home_page | |
| Summary | CLI tool of Base Template Repository. |
| upload_time | 2024-01-31 14:28:59 |
| maintainer | |
| docs_url | None |
| author | haru |
| requires_python | ~=3.11 |
| license | |
| keywords |
base-template
cli
template
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Base Template CLI
[](https://github.com/haru52/base_template_cli/actions/workflows/test.yml)
[](https://github.com/haru52/base_template_cli/actions/workflows/release.yml)
[](https://github.com/haru52/base_template_cli/actions/workflows/github-code-scanning/codeql)
[](CODE_OF_CONDUCT.md)
[](https://commitizen.github.io/cz-cli/)
[](https://github.com/semantic-release/semantic-release)
## Overview
CLI tool of [Base Template Repository](https://github.com/haru52/base_template#readme).
## Requirements
| Tool | Version |
| ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| [Base Template Repository](https://github.com/haru52/base_template) or its [Japanese version](https://github.com/haru52/base_template_ja) | ^7.8.0 or ^6.8.0 (ja) |
You have to clone either `base_template` or `base_template_ja` repo to your machine before using Base Template CLI.
```sh
git clone git@github.com:haru52/base_template.git
# or
git clone git@github.com:haru52/base_template_ja.git
```
## Installation
```sh
pip install base-template-cli
```
## Usage
```console
Usage: base-template-cli [OPTIONS] COMMAND [ARGS]...
Base Template CLI.
Options:
--version Show the version and exit.
-h, --help Show this message and exit.
Commands:
apply Apply (Copy) Base Template boilerplates to the destination repo.
```
```console
Usage: base-template-cli apply [OPTIONS]
BASE_TEMPLATE_ROOT_PATH
Apply (Copy) Base Template boilerplates to the destination repo.
Options:
-d, --dst TEXT Destination repo root path.
-t, --target-dirs TEXT Target directories to copy (e.g., .husky,
.github/ISSUE_TEMPLATE). If you don't specify this
option, this command copies all files of Base
Template to the destination repo. If you want to
copy only root files, use --only-root option.
-r, --only-root Copy only root directory files of Base Template
repo.
-l, --lang TEXT Language of Base Template. `en` or `ja`.
-h, --help Show this message and exit.
```
## Update
```sh
pip install -U base-template-cli
```
## Uninstall
```sh
pip uninstall base-template-cli
```
## Versioning policy
[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)
## License
[MIT](https://github.com/haru52/base_template_cli/blob/main/LICENSE)
## Contributing
[Contributing Guideline](https://haru52.github.io/base_template_cli/CONTRIBUTING.html)
<!-- vale Microsoft.Vocab = NO -->
## Documentation
[Documentation | base_template_cli](https://haru52.github.io/base_template_cli/)
## Author
<!-- vale Microsoft.Vocab = YES -->
[haru](https://haru52.com/)
Raw data
{
"_id": null,
"home_page": "",
"name": "base-template-cli",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.11",
"maintainer_email": "",
"keywords": "base-template,cli,template",
"author": "haru",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8c/c4/2e85e83467df12f9cc00034b7f9ffcfa0a643756473078bac53468dce2c7/base_template_cli-3.0.2.tar.gz",
"platform": null,
"description": "# Base Template CLI\n\n[](https://github.com/haru52/base_template_cli/actions/workflows/test.yml)\n[](https://github.com/haru52/base_template_cli/actions/workflows/release.yml)\n[](https://github.com/haru52/base_template_cli/actions/workflows/github-code-scanning/codeql)\n[](CODE_OF_CONDUCT.md)\n[](https://commitizen.github.io/cz-cli/)\n[](https://github.com/semantic-release/semantic-release)\n\n## Overview\n\nCLI tool of [Base Template Repository](https://github.com/haru52/base_template#readme).\n\n## Requirements\n\n| Tool | Version |\n| ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |\n| [Base Template Repository](https://github.com/haru52/base_template) or its [Japanese version](https://github.com/haru52/base_template_ja) | ^7.8.0 or ^6.8.0 (ja) |\n\nYou have to clone either `base_template` or `base_template_ja` repo to your machine before using Base Template CLI.\n\n```sh\ngit clone git@github.com:haru52/base_template.git\n# or\ngit clone git@github.com:haru52/base_template_ja.git\n```\n\n## Installation\n\n```sh\npip install base-template-cli\n```\n\n## Usage\n\n```console\nUsage: base-template-cli [OPTIONS] COMMAND [ARGS]...\n\n Base Template CLI.\n\nOptions:\n --version Show the version and exit.\n -h, --help Show this message and exit.\n\nCommands:\n apply Apply (Copy) Base Template boilerplates to the destination repo.\n```\n\n```console\nUsage: base-template-cli apply [OPTIONS]\n BASE_TEMPLATE_ROOT_PATH\n\n Apply (Copy) Base Template boilerplates to the destination repo.\n\nOptions:\n -d, --dst TEXT Destination repo root path.\n -t, --target-dirs TEXT Target directories to copy (e.g., .husky,\n .github/ISSUE_TEMPLATE). If you don't specify this\n option, this command copies all files of Base\n Template to the destination repo. If you want to\n copy only root files, use --only-root option.\n -r, --only-root Copy only root directory files of Base Template\n repo.\n -l, --lang TEXT Language of Base Template. `en` or `ja`.\n -h, --help Show this message and exit.\n```\n\n## Update\n\n```sh\npip install -U base-template-cli\n```\n\n## Uninstall\n\n```sh\npip uninstall base-template-cli\n```\n\n## Versioning policy\n\n[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)\n\n## License\n\n[MIT](https://github.com/haru52/base_template_cli/blob/main/LICENSE)\n\n## Contributing\n\n[Contributing Guideline](https://haru52.github.io/base_template_cli/CONTRIBUTING.html)\n\n<!-- vale Microsoft.Vocab = NO -->\n\n## Documentation\n\n[Documentation | base_template_cli](https://haru52.github.io/base_template_cli/)\n\n## Author\n<!-- vale Microsoft.Vocab = YES -->\n\n[haru](https://haru52.com/)\n",
"bugtrack_url": null,
"license": "",
"summary": "CLI tool of Base Template Repository.",
"version": "3.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/haru52/base_template_cli/issues",
"Homepage": "https://github.com/haru52/base_template_cli#readme",
"Repository": "https://github.com/haru52/base_template_cli.git"
},
"split_keywords": [
"base-template",
"cli",
"template"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cacbca07495a64db2d2891e98049a259b53b1ac6147e7a65d2fae1580711b687",
"md5": "b7ece18a84be50824a92e9ec2233b5a0",
"sha256": "6e6955f1ccbd8239786006780e606012e570a9c992b9fd8061a791630604cf24"
},
"downloads": -1,
"filename": "base_template_cli-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b7ece18a84be50824a92e9ec2233b5a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.11",
"size": 7053,
"upload_time": "2024-01-31T14:28:54",
"upload_time_iso_8601": "2024-01-31T14:28:54.695640Z",
"url": "https://files.pythonhosted.org/packages/ca/cb/ca07495a64db2d2891e98049a259b53b1ac6147e7a65d2fae1580711b687/base_template_cli-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8cc42e85e83467df12f9cc00034b7f9ffcfa0a643756473078bac53468dce2c7",
"md5": "a7b1c3af8c82818d6aeb3e21dc4bd971",
"sha256": "264c9252614e9e76ab3987a925ad59c55b84962b9bfd880ff5d7a97d8a52cc96"
},
"downloads": -1,
"filename": "base_template_cli-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "a7b1c3af8c82818d6aeb3e21dc4bd971",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.11",
"size": 123112,
"upload_time": "2024-01-31T14:28:59",
"upload_time_iso_8601": "2024-01-31T14:28:59.160633Z",
"url": "https://files.pythonhosted.org/packages/8c/c4/2e85e83467df12f9cc00034b7f9ffcfa0a643756473078bac53468dce2c7/base_template_cli-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 14:28:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "haru52",
"github_project": "base_template_cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "base-template-cli"
}
