Skip to main content

Concurrent and flexible task runner

Project description


pypi bld cvg black

Rye is a python task automation tool. It is one of a long list of other projects. The question at this point should be, why not just use one of thos other tools? The answer is that I had a workflow in mind, but couldn’t quite get any of the other tools to do it.

  • Read from a simple config file

  • Maintain a set of virtualenvs for each environment

  • Update those environments when my pyproject.toml or poetry.lock files changed.

  • Run all my tasks in parallel

  • Let tasks share environments where that makes sense (lint and typing?)

  • Work with poetry

  • Allow installing dependencies and the package separately (for Dockerfile caching)

I was trying to set this up without thinking it through a ton, and kept fighting with tox’s built in defaults. No way to install packages without the source code. Using poetry involved some truly ugly hacks. No auto-update of environments, and hard to share environments between tasks. I did like that it depended on a config file with a lot of built in behaviors that you could inherit from!

I looked at stuff like Nox and Invoke- Nox required more programming then tox and still had a bunch of defaults I’d have to figure out how to override. Invoke would have just been working from scratch.

What I really wanted was a makefile- list tasks, specify dependencies for those tasks, and rebuild them when the dependencies change. The actual commands to run should be completely configurable. So Rye was born. It uses pyproject.toml as configuration. It will automatically keep your virtual environments in sync with your config files- no matter the tool you’re using. It has a good set of default behaviors you can pull in. Best of all, every step of the process is completely configurable- if you want!

# pyproject.toml
default_tasks = ["test", "lint", "format", "typing"]

target_environments = ["poetry.py37", "poetry.py36"]

commands = [["pytest", "tests", "--no-cov"]]

target_environments = ["poetry.py37"]
commands = [["pylint", "src/rye", "tests"]]

target_environments = ["poetry.py37"]
commands = [
        ["black", ".", "--check"],
        ["isort", "-rc", "-tc", "--check-only", "src", "tests"],

target_environments = ["poetry.py37"]
commands = [
        ["mypy", "src/rye", "--ignore-missing-imports"],


  - test
  - lint
  - format
  - typing

    - poetry.py37
    - poetry.py36

     - ["pytest", "tests", "--no-cov"]

    - poetry.py37
    - ["pylint", "src/rye", "tests"]

    - poetry.py37
    - ["black", ".", "--check"]
    - ["isort", "-rc", "-tc", "--check-only", "src", "tests"]

    - poetry.py37
    - ["mypy", "src/rye", "--ignore-missing-imports"]
$ rye
Running tasks- ['poetry.py37', 'TASK poetry.py37#lint', 'TASK poetry.py37#format', 'TASK poetry.py37#typing']
ENV poetry.py37 > Preparing Env
ENV poetry.py37 > Already using interpreter /home/pbecotte/venvs/rye/bin/python3.7
ENV poetry.py37 > Using base prefix '/usr'
ENV poetry.py37 > New python executable in /home/pbecotte/PycharmProjects/rye/.rye/py37/bin/python3.7
ENV poetry.py37 > Also creating executable in /home/pbecotte/PycharmProjects/rye/.rye/py37/bin/python
ENV poetry.py37 > Installing setuptools, pip, wheel...

Read the full documentation at Or check out the source at


You can install Rye from pypi-

pip install rye

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rye-0.6.1.tar.gz (10.3 kB view hashes)

Uploaded Source

Built Distribution

rye-0.6.1-py3-none-any.whl (10.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page