https://github.com/andreoliwa/conjuring
🐍 🤖 Reusable global Invoke tasks that can be merged with local project tasks
https://github.com/andreoliwa/conjuring
invoke project-automation python tasks
Last synced: 7 months ago
JSON representation
🐍 🤖 Reusable global Invoke tasks that can be merged with local project tasks
- Host: GitHub
- URL: https://github.com/andreoliwa/conjuring
- Owner: andreoliwa
- Created: 2021-12-18T18:12:15.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-07-14T19:14:29.000Z (7 months ago)
- Last Synced: 2025-07-14T23:50:08.145Z (7 months ago)
- Topics: invoke, project-automation, python, tasks
- Language: Python
- Homepage: https://andreoliwa.github.io/conjuring/
- Size: 2.71 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: docs/README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Conjuring
Reusable global [Invoke](https://github.com/pyinvoke/invoke) tasks that can be
merged with local project tasks.
## Features
- Merge any local `tasks.py` file with global Conjuring tasks
- Use all global Conjuring tasks provided by this package
- Only include the global Conjuring tasks you want (opt-in spells)
- Use all Conjuring tasks excluding some (opt-out spells)
- Add your own custom tasks from Python modules or packages to global tasks
- Display your custom task modules conditionally
- Display your custom individual tasks conditionally
- Merge your project tasks with the global reusable tasks
- Prefix task names of your custom module
More details on the [features documentation](https://andreoliwa.github.io/conjuring/features/).
## Tasks
Each module under [the `conjuring/spells` directory](https://github.com/andreoliwa/conjuring/tree/master/src/conjuring/spells)
is a collection of Invoke tasks.
Read more in [Spells (API reference)](https://andreoliwa.github.io/conjuring/spells/).
## Quick setup
Install Conjuring in an isolated virtualenv with [pipx](https://github.com/pypa/pipx):
```shell
pipx install --include-deps conjuring
```
The `--include-deps` flag is needed to install Invoke's apps (`invoke` and `inv`).
Run the command to configure files on your home directory:
```shell
# For more options:
# conjuring init --help
conjuring init
```
You should see the list of Conjuring tasks from any directory where you type this:
```shell
invoke --list
```
For more configuration options, [read the detailed documentation](https://andreoliwa.github.io/conjuring/features/#modes).