Skip to content

Quick rye/pytest/yarn/actions setup for a pypi project

Notifications You must be signed in to change notification settings

ffreemt/cookiecutter-rye

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

cookiecutter-rye template (WIP)

Code style: blackLicense: MIT

Quick rye/pytest/yarn/actions setup for a pypi project

Usage

  • Install rye (possibly also uv) and yarn (or npm) the way you like it

  • Run

pip install cookiecutter # or pipx install cookiecutter

# this creates the package directory structure according the `cookiecutter-rye` template
cookiecutter gh:ffreemt/cookiecutter-rye

# or cookiecutter https://github.com/ffreemt/cookiecutter-rye.git
  • cd to the package directory
cd pack_name
  • Run
# this installs some libs given in pyproject.toml
rye pin 3.12.0  # other python version
rye sync

# this installs npm-run-all given in package.json
yarn  # or npm install

Now you have a project set up and can start coding and change the world for the better;). For exmaple

rye add  httpx
rye sync  # or much faster:  uv install httpx 
  • Shortcuts are set in package.json. Take a look and get a rough idea. For example

    • yarn test
    • yarn style: will run black tests pack_name and reload when any .py file is modified in tests and pack_name directories.
  • build and publish

    • rye build
    • rye publish

About

Quick rye/pytest/yarn/actions setup for a pypi project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published