https://github.com/fastapi-mvc/copier-script
Copier template for scaffolding new shell script
https://github.com/fastapi-mvc/copier-script
copier-template scaffolding
Last synced: 4 months ago
JSON representation
Copier template for scaffolding new shell script
- Host: GitHub
- URL: https://github.com/fastapi-mvc/copier-script
- Owner: fastapi-mvc
- License: mit
- Created: 2022-10-31T11:03:20.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-01T17:37:41.000Z (about 1 year ago)
- Last Synced: 2025-01-10T16:13:58.808Z (5 months ago)
- Topics: copier-template, scaffolding
- Language: Nix
- Homepage:
- Size: 51.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Copier Script
Copier template for scaffolding new script upon [fastapi-mvc](https://github.com/fastapi-mvc/fastapi-mvc) project.
## Quickstart
### Using fastapi-mvc
Prerequisites:
* fastapi-mvc
* Git 2.27 or newer
```shell
git clone "https://github.com/fastapi-mvc/copier-script.git"
FMVC_PATH="$PWD:$FMVC_PATH" fastapi-mvc generate script /path/to/your/new/script
```
### Using copier
To use this template outside `fastapi-mvc`:
Prerequisites:
* Python 3.8 or later [How to install python](https://docs.python-guide.org/starting/installation)
* Git 2.27 or newer
* copier 6.2.0 or later
```shell
copier copy "https://github.com/fastapi-mvc/copier-script.git" /path/to/your/new/script
```
## Using Nix
Prerequisites:
* Nix 2.8.x or later installed [How to install Nix](https://nixos.org/download.html)
```shell
nix develop
copier copy "https://github.com/fastapi-mvc/copier-script.git" /path/to/your/new/script
```
## Updating
To update your generator with the changes from the [upstream](https://github.com/fastapi-mvc/copier-generator) run:
```shell
./update.sh
# Or
nix run .#update
```
This action will not update/override your template and its configuration, but rather generators common files:
* Nix expression files
* `README.md`
* dotfiles
* `LICENSE`
List of excluded files/paths:
* `template/**`
* `copier.yml`
* `*.py`
* `CHANGELOG.md`
Lastly, you can pass extra copier CLI options should you choose:
```shell
./update.sh -x README.md --vcs-ref=custom_branch
# Or
nix run .#update -- -x README.md --vcs-ref=custom_branch
```