Skip to content

baggiponte/pymi-cookiecutter

Repository files navigation

🍪 Get started with cookiecutter

cookiecutter slidev

Source code for the talk on Cookiecutter at Python Milano.

🛩️ 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
# with github CLI
gh repo clone baggiponte/pymi-cookiecutter

# with git
git clone [email protected]:baggiponte/pymi-cookiecutter

Note

🎬 How to configure SSH

Cloning over SSH is safer. Follow this guide. Alternatively, you can follow the steps in this workshop of GitHub's.

  1. Install the dependencies
# with the command runner
just install

# Alternatively
npm install
pdm install
  1. Open the slideshow locally
# with the command runner
just preview

# with npx
npx slidev --open -- slides.md
  1. Visit http://localhost:3030

  2. Run the cookiecutter template:

pdm run cookiecutter sample-cookiecutter

🤗 contributing

Install the dependencies above (just is highly recommended) and the following:

  • 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:
just test-release

This will format the slides, try to build them and test whether a version bump is possibile.

Note

Credits:

  • slidev is an amazing framework to build slides from markdown and host them.
  • just is just a command runner.
  • commitizen is a release management tool.
  • cookiecutter is an open source library to build coding project templates.