https://github.com/edvardm/demake
Helper to translate Makefile rules to PyInvoke tasks.py file
https://github.com/edvardm/demake
developer-experience developer-tools invoke productivity task-automation
Last synced: 11 months ago
JSON representation
Helper to translate Makefile rules to PyInvoke tasks.py file
- Host: GitHub
- URL: https://github.com/edvardm/demake
- Owner: edvardm
- License: mit
- Created: 2022-10-01T17:40:11.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T18:04:50.000Z (almost 3 years ago)
- Last Synced: 2025-03-09T01:31:11.516Z (11 months ago)
- Topics: developer-experience, developer-tools, invoke, productivity, task-automation
- Language: Haskell
- Homepage:
- Size: 94.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Demake
Version 0.1.6
## Overview
Helper to convert Makefiles to [PyInvoke](https://www.pyinvoke.org/) files,
see [sample run below](#sample-run)
## Rationale
Makefiles typically contain rules to build files based on dependencies,
whereas [PyInvoke](https://www.pyinvoke.org/) is used for task automation.
These are two separate things.
[GNU Make](https://www.gnu.org/software/make/) is a powerful tool, so it is
often used for task automation as well, mainly because it is already present
in many development environments, and most people are familiar with the basic
syntax. Problem is, Make is not very suitable for complex rules. Error
handling, condition logic, passing arbitrary command line arguments etc is not
where it really shines.
In the end there shouldn't even be battle between Make and task automation
tools. In fact, in some cases it makes totally sense to have both PyInvoke for
convenient task automation, and Make for incremental builds. PyInvoke, like
many task automation tools, doesn't offer support for building items
automatically based on extension, or running build targets based on file
modification time. In such cases, it would be totally reasonable to use
PyInvoke as main automation tool for developers, and let Make handle
incremental builds and nothing else.
Sure, complex Make tasks can be extracted to shell scripts, but then the same
arguments about awkward programmability would arise as with Make.
## Purpose of Demake
It helps you by transforming some of the rules in existing `Makefile`s to
`tasks.py` files used by PyInvoke. It is by no means complete and it is quite
likely that you need to modify generated `tasks.py` before it is useful, with
the exception of very trivial Makefiles. It should still save you from some
manual work, and for me it was a good excuse to something bit more serious
with Haskell than just to dabble with `ghci` solving [Project
Euler](https://projecteuler.net/) problems.
## Install instructions
clone the repository, then do
```bash
stack build && \
stack install && \
echo "installed to $(stack path --local-bin)"
```
If you don't have Stack setup already, I recommend using
[ghcup](https://www.haskell.org/ghcup/) to install it.
With Makefile contents of
```Makefile
.PHONY: deps
TEST_DIR := tests
.PHONY: dev-init
dev-init: .check-poetry deps quick-test ## prepare project ready for development
.PHONY: .check-poetry
.check-poetry:
@command -v poetry 2>/dev/null || (echo "poetry not found, please see https://python-poetry.org/docs/#installation"; exit 1)
.PHONY: deps
deps: ## install dependencies
poetry install --no-root
.PHONY: quick-test
quick-test: opts ?= --durations 3
quick-test:
pytest $(opts) -m "not slow" $(TEST_DIR)
```
Resulting output:
```python
from invoke import task
TEST_DIR = "tests"
@task
def deps(c):
c.run('poetry install --no-root')
@task
def _check_poetry(c):
c.run('command -v poetry 2>/dev/null || (echo "poetry not found, please see https://python-poetry.org/docs/#installation"; exit 1)')
@task
def quick_test(c):
c.run(f'pytest {opts} -m "not slow" {TEST_DIR}')
@task(pre=[_check_poetry, deps, quick_test])
def dev_init(c):
pass
```
## Credits
Nicolas Mattias for his [Makefile
library](https://github.com/nmattia/makefile), which I modified a bit to
support parsing of top-level and inline comments