Run update

Author: rszamszur

.envrc

@@ -0,0 +1 @@
+use nix

.generator.yml

@@ -0,0 +1,9 @@
+# Changes here will be overwritten by Copier
+_commit: d24bc7d
+_src_path: https://github.com/fastapi-mvc/copier-generator
+copyright_date: '2022'
+generator: controller
+generator_name: controller
+license: MIT
+nix: true
+repo_url: https://github.com/fastapi-mvc/copier-controller

.gitignore

@@ -0,0 +1,37 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+flake8_code_errors.txt
+pep257_violations.txt
+pep8_violations.txt
+code_complexity.txt
+xunit-*.xml
+
+# PyCharm
+.idea
+
+# virtual
+venv
+.venv
+
+# direnv
+.direnv
+
+# Nix build result
+result

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,53 @@
-# copier-controller
+## Copier Controller
 
-more info soon
+Copier template for scaffolding new controller upon [fastapi-mvc](https://github.com/fastapi-mvc/fastapi-mvc) project.
 
+## Quickstart
+
+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-controller.git" /path/to/your/new/project
+```
+
+## Using Nix
+
+```shell
+nix-shell shell.nix
+copier copy "https://github.com/fastapi-mvc/copier-controller.git" /path/to/your/new/project
+```
+
+## Updating
+
+To update your generator with the changes from the [upstream](https://github.com/fastapi-mvc/copier-generator) run:
+
+```shell
+./update.sh
+```
+
+This action will not update/override your template and its configuration, but rather generators common files:
+
+* Environment (`pyproject.toml` and `poetry.lock`)
+* `README.md`
+* Nix expression files
+* 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
+```

default.nix

@@ -0,0 +1,9 @@
+{ python
+, poetry2nix
+}:
+
+poetry2nix.mkPoetryEnv {
+  inherit python;
+  pyproject = ./pyproject.toml;
+  poetrylock = ./poetry.lock;
+}