A language agnostic make-like tool meant for python projects
Project description
Taskr
A magical, easy to use task runner with an original name. Semi-inspired by (Mage)[https://github.com/magefile/mage], a task runner for go. Made for python projects, but usable for any.
All that's needed is a tasks.py file in the same folder you are invoking "taskr" from
Installing
pip install taskr-cli
Check the version
taskr --version
Using
Ensure you have a tasks.py file defined in the root of your repo. To generate a template, run taskr --init
. From there you can modify it and add tasks.
CLI:
[master●] » taskr -h
usage: taskr [-h] [-v] [-l] [-i] [-e]
A small utility to run tasks
optional arguments:
-h, --help show this help message and exit
-v, --version Show the version number
-l, --list Show defined tasks
-i, --init Generate a template task.py file
-e, --env List environment variables set before a task is run
When listing tasks, taskr will attempt to grab the docblock and show it, or use a single # comment above the task function. These are the ones that exist for it's own project
[master●] » taskr -l
Tasks:
all : Runs all static analysis tools
build : Builds the wheel
clean : Remove build artifacts, cache, etc.
flake : Check flake8
fmt : Run black
mypy : Checks types
*reinstall : Re-installs taskr
sort : Sort imports
test : Run tests
upload_prod : Send it for real!
upload_test : Send it!
* = default
To run a task, just pass the name of a function. Output from a task will be displayed
[master●] » taskr format
All done! ✨ 🍰 ✨
11 files left unchanged.
You can also define "internal" functions that taskr will ignore when listing by pre-pending the name with an underscore.
import taskr
# Tasker will not list this
def _get_system():
return os.environ.get("build_system")
def build():
system = _get_system()
taskr.run_env("python setup.py install", env={"BUILD_SYSTEM": system})
Config
There are a few configuration setting, set in tasks.py itself.
Placing VENV_REQUIRED = True
in your tasks.py file, taskr will only run if it detects it's running in a virtual environment. You can delete it otherwise
Default tasks are run when taskr
is run without any arguments. You can set this by setting a variable DEFAULT = "some_func"
to the name of a task in tasks.py.
DEFAULT = "test"
VENV_REQUIRED = True
# Run tests
def test
taskr.run("python -m pytest tests/")
And calling it
# will run 'test' function
taskr
Helpful functions for running tasks
A few utility methods are provided for system running tasks. Taskr expects task functions to return either True
(The task was successful) for False
it failed. To determine if a task was successful or not, taskr looks at the return code of the called program. 0 is success, anything else fails.
Taskr will auto copy your existing environment variables when running tasks, so running tasks with programs installed in a virual environment (i.e. dev tools though pip) will work.
run
run
's argument can be either a list, or a string. A list is parsed into one command, not multiple
Optionally pass a an environment dictionary to be used at runtime.
import taskr
def flake() -> bool:
return taskr.run(["python", "-m", "flake8", "taskr/*.py"])
# Runs flake8
def flake() -> bool:
return taskr.run("python -m flake8 taskr/*.py")
# Build a wheel
def build():
ENV = {
"PRODUCTION": "true"
}
return taskr.run("python setup.py install", ENV)
run_conditional
run_conditional
is a way to run tasks (functions) in order, as long as the previous task returns a non failure return code (False). You can throw normal python functions in here to
import taskr
import some_package as sp
# Run black
def fmt():
return taskr.run("python -m black .")
# Check flake8
def flake():
return taskr.run(["python", "-m", "flake8", "taskr/*.py"])
# Run all static tools
def all():
return taskr.run_conditional(flake, fmt, sp.function)
run_output
run_output
' will run a command and return the output
import taskr
# Get the number of env variables
def _get_count():
ret = taskr.run_output("env | wc -l")
print(ret.status) # True
print(ret.stdout) # "90"
print(ret.sterr) # ""
You can an environment dict to this function, the same way as
run_env
Passing arguments to functions
You can also pass arbitrary arguments to any defined function. For example, passing the environment to starting a server. This requires the function to have a default argument set
def start(env: str = "Dev"):
ENVS = {
"ENV": env
}
return taskr.run("python startpy", ENVS)
And from the command line
taskr start dev
# Or
taskr start #starts dev
# Or
taskr start prod
Arguments are passed in order they are typed.
Utilities
There are a few utility functions included
# Removes dist/build folders
cleanBuilds() -> Bool
# Remove compiled filed and folders
cleanCompiles() -> Bool
# In a venv or not
inVenv() -> bool
# Reads an ENV file into a dict. See example in tests/data
readEnvFile(filename: str) -> dict
# Bumps setup.py's version number by .1, or argument
bumpVersion(version: str = None) -> bool:
Developing
This project uses pipenv. Make sure it's installed. Then call
python -m pipenv shell
pipenv install --dev
taskr test
There are numerous tests in taskr/tests
which cover most functionality that's testable
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for taskr_cli-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2030ba81679cbee072e190f73d33b8532440f9e0d154f904adeda379399cac7e |
|
MD5 | 0af104562890dddea5ca15c44f8bed44 |
|
BLAKE2b-256 | acc59a572c159209966a63d8549cf16ffc5e5a3e3e17684e1c7ee2cdd6e70eaf |