Skip to main content

Sleet

A configuration driven project initializer without boilerplates

What is this?

Sleet is a project initializer, but unlike similar already existing tools like cookiecutter, sleet doesnt depend on boilerplates. Instead sleet builds upon real time command execution and a config-driven workflow. Sleet has integration with modern tools such as git and uv built in with letting you code your own integrations coming soon.

Preview!

Heres a config snippet showing how sleet works:

meta:
  desc: "My cool setup script"
  author: "Cool developer dude"

exec:
  - uv-init:
      type: "uv-init"

  - install-venv:
      type: "uv-venv"
      version: "3.14"

  - install-tools:
      type: "uv-install"
      names: ["pytest", "ruff", "pre-commit"]
      dev: True

  - commit:
      type: "git-commit"

But sleet can do so much more! It has support for executing custom commands and creating/editing files.

Roadmap

  • Core module functionality
  • Working CLI
  • Loading custom modules
  • Better error handling / logging
  • Builtin configs

Installation

The tool can be installed in multiple ways, but we recommend you use uv tool to install it globally in your system:

uv tool install sleet

But if you dont have uv installed, dont worry! You can also install using pip/pipx:

pipx install sleet

Getting Started

Getting the config path

Sleet reads configs from a set config path, which is varied between operating systems but you can find out what it is for you with the sleet listdata command where you can look for the "Config Path" data entry.

For example, here is where my configs will be stored as i am on linux: /home/cheetah/.config/sleet/configs

Writing your first config

Alright, now you finally know where to store your configs, but what now? Lets start by creating a tiny config, create a file inside the config directory (create the directory if needed) called myconfig.yaml and paste in the following:

meta:
  desc: "My cool setup script"
  author: "Cool developer dude"

exec:
  - initalize-git:
      type: "git-init"

  - initial-commit:
      type: "git-commit"
      message: "my first commit!"

congratulations, you have created your first config! Now you can navigate to a new directory and run sleet run myconfig in the terminal to execute your config!

If you havent noticed already this config initializes a new repo and makes an initial commit.

Explanation

Lets go over everything we just wrote step by step:

  • the name (myconfig.yaml) - what you call your config, remove the .yaml and you have the name youll use when running the config.
  • Metadata (desc and author) - Currently has no purpouse but is recommended as it will be used for planned features (that are coming really soon).
  • exec tasks (in this example: the initialize git and commit steps) - Each part of a setup config is called a task, well dig a bit deeper into one of them, the initial-commit task:
    • - initial-commit: - the label of the task, can be anything and will be used in logging when running the config
    • type: "git-commit" - the type of task, for a full list of tasks please refer to the Task Type List
    • message: "my first commit!" - A type specific argument, some tasks dont have an argument, some have multiple. For information about each types arguments, please refer to the Task Type List

Adding more

Lets extend this config to also write an .gitignore before commiting, we can do this by adding another task, specifically with the "file-write" type:

  - configure-precommit:
      type: "file-write"
      path: ".gitignore"
      contents: |
      __pycache__/
      .venv
      .ruff_cache

Note that this contains multiline strings, i will not go over those in this guide.

Lets add this step before we commit our changes:

meta:
  desc: "My cool setup script"
  author: "Cool developer dude"

exec:
  - initalize-git:
      type: "git-init"

  - configure-precommit:
      type: "file-write"
      path: ".gitignore"
      contents: |
      __pycache__/
      .venv
      .ruff_cache

  - initial-commit:
      type: "git-commit"
      message: "my first commit!"

That is the basics! To learn about all the different task types you can refer to the Task Type List.

Contributing

Note that before contributing all your changes should go through the pre-commit config, further contribution / developement documentation is coming soon!

For now, use pre-commit, dependencies are in the "dev" dependency group, also explain every change you make in the pr so i can better understand why they should be added.

Metadata

Release files for sleet 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sleet 0.1.0
File Size Uploaded Provenance Actions
sleet-0.1.0.tar.gz 8.1 kB Without provenance Details for sleet-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sleet 0.1.0
File Interpreter ABI Platform Actions
sleet-0.1.0-py3-none-any.whl Python 3 none any Details for sleet-0.1.0-py3-none-any.whl

Total release size: 16.7 kB

Release files / sleet-0.1.0.tar.gz

Download URL sleet-0.1.0.tar.gz
Size 8.1 kB
Tags Source
SHA-256 checksum
How to use checksums
e9ce93140bca5e318c96dc4d04ffbea6ad66f2bc31ebac081ed3e7f70036b9ab
BLAKE2b-256 checksum
How to use checksums
c99022e5c7e679064dbb6405385c8ae991aaeb48fab7f386e1c754d15a6c6758
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / sleet-0.1.0-py3-none-any.whl

Download URL sleet-0.1.0-py3-none-any.whl
Size 8.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
57aafbb102c7b6825b8d26f4ff6c8a1cc198e7698b6a4ed854a06ea6269dba3d
BLAKE2b-256 checksum
How to use checksums
b1bf3902d1fdd3829e8eb73ac8277f75b55bc0e8dfb57f0056693a614af1221c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for sleet 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page