https://github.com/baggiponte/pymi-cookiecutter
đĒ @cookiecutter tutorial @PythonMilano
https://github.com/baggiponte/pymi-cookiecutter
cookiecutter python template template-engine tutorial
Last synced: about 2 months ago
JSON representation
đĒ @cookiecutter tutorial @PythonMilano
- Host: GitHub
- URL: https://github.com/baggiponte/pymi-cookiecutter
- Owner: baggiponte
- Created: 2022-10-19T14:00:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T13:40:30.000Z (over 2 years ago)
- Last Synced: 2024-02-23T14:41:28.198Z (over 2 years ago)
- Topics: cookiecutter, python, template, template-engine, tutorial
- Language: Just
- Homepage: https://baggiponte.github.io/pymi-cookiecutter/
- Size: 1.09 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# đĒ Get started with `cookiecutter`
[](https://github.com/baggiponte/cookiecutter-slidev)
Source code for the talk on [Cookiecutter](https://www.cookiecutter.io/) at [Python Milano](https://github.com/PythonMilano).
* đŊī¸ [Live](https://www.youtube.com/watch?v=XESObnka5Nc)
## đŠī¸ How to run
Make sure you have installed the following:
* `git` (of course)
* GitHub CLI: `gh` (optional)
* `node.js`
* `just` is a command runner (optional, recommended for contributing)
1. Clone the repo
```bash
# with github CLI
gh repo clone baggiponte/pymi-cookiecutter
# with git
git clone git@github.com:baggiponte/pymi-cookiecutter
```
> **Note**
>
> đŦ How to configure SSH
>
> Cloning over SSH is safer. Follow [this guide](https://www.youtube.com/watch?v=5o9ltH6YmtM).
> Alternatively, you can follow the steps in [this](https://github.com/git-merge-workshops/simplify-signing-with-ssh/blob/main/exercises/01-setup-workstation.md) workshop of GitHub's.
2. Install the dependencies
```bash
# with the command runner
just install
# Alternatively
npm install
pdm install
```
3. Open the slideshow locally
```bash
# with the command runner
just preview
# with npx
npx slidev --open -- slides.md
```
4. Visit http://localhost:3030
5. Run the cookiecutter template:
```bash
pdm run cookiecutter sample-cookiecutter
```
## đ¤ contributing
Install the dependencies [above](,/README.md#%EF%B8%8F-how-to-run) (`just` is highly recommended) and the following:
* [`commitizen`](https://commitizen-tools.github.io/commitizen/) is a release management tool. It's used to release new versions.
1. Fork the repo
2. Create your own branch.
3. Before opening a PR, run the following:
```bash
just test-release
```
This will format the slides, try to build them and test whether a version bump is possibile.
> **Note**
>
> Credits:
>
> - [`slidev`](https://github.com/slidevjs/slidev) is an amazing framework to build slides from markdown and host them.
> - [`just`](https://github.com/casey/just) is just a command runner.
> - [`commitizen`](https://commitizen-tools.github.io/commitizen/) is a release management tool.
> - [`cookiecutter`](https://www.cookiecutter.io) is an open source library to build coding project templates.