Skip to main content

No project description provided

Project description

Intro

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 by, why? 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. 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. I know enough to set this up with a Makefile- but that would be a decent amount of custom code. What if I could make it LOOK like tox, but behave like Make?

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

[tool.rye."task.pytest"]
target_environments = ["poetry.py37", "poetry.py36"]

[tool.rye."poetry.py36"."task.pytest"]
commands = [["pytest", "tests", "--no-cov"]]

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

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

[tool.rye."task.typing"]
target_environments = ["poetry.py37"]
commands = [
        ["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 https://rye.readthedocs.io/en/latest/ Or check out the source at https://gitlab.com/pjbecotte/rye

Installation

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.1.0.tar.gz (8.1 kB view hashes)

Uploaded Source

Built Distribution

rye-0.1.0-py3-none-any.whl (8.3 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