https://github.com/tnarik/copier-python
Copier template for python projects
https://github.com/tnarik/copier-python
copier copier-template poetry python
Last synced: 7 months ago
JSON representation
Copier template for python projects
- Host: GitHub
- URL: https://github.com/tnarik/copier-python
- Owner: tnarik
- Created: 2022-10-05T13:46:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-23T08:34:03.000Z (almost 3 years ago)
- Last Synced: 2025-01-11T18:08:52.763Z (9 months ago)
- Topics: copier, copier-template, poetry, python
- Language: Jinja
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# copier-python
A [Copier](https://github.com/copier-org/copier) template for Python projects.
## Features
[Poetry](https://github.com/python-poetry/poetry) used for package dependency management.
## Pre-usage instructions
Currently, this [Copier](https://github.com/copier-org/copier) template relies on and requires the [copier-templates-extensions](https://github.com/copier-org/copier-templates-extensions) plugin so that an embedded Jinja2 extension (`extensions/shell.py`) can be properly loaded and used in templates.
The plugin needs to be installed in the Python environment that is used with `copier`. If `copier` is installed via Homebrew (as it is the case in my setup), the easiest way would be to run the following from the command line:
`$(brew --prefix copier)/libexec/bin/pip3 install copier-templates-extensions`
The embedded `extensions/shell.py` extension is used because even when a Jinja2 3.x version of [jinja2-shell-extension](https://github.com/metwork-framework/jinja2_shell_extension) is now published, the embedded version includes additional parameters.
## Usage
Generation of a project is as simple as running:
`copier "gh:tnarik/copier-python" /path/to/your/new/project`
### Additional setup
Once the project has been created, you can go ahead and `cd` into the project folder.
If your system is configured to run the `direnv` hooks (it should, see [WORKBENCH.md](WORKBENCH.md)), then you just need to execute:
```
direnv allow .
poetry install
```
These commands will setup the automated activation of the project local virtual environment and install all DEV dependencies.
## Alternatives
Perhaps something like [pawamoy/copier-poetry](https://github.com/pawamoy/copier-poetry) is preferable for some people, but it includes too much magic and post-generation scripts which is something I prefer not using. In any case, you can give it a try.