Judoka
Judoka is a command line utility that lets you define project scoped commands and call them through their alias. It lets you just do (= judo) your work.
Installation
Install this library using pip:
$ pip install judoka
Usage
Create a .judorc file in your project root, like the example below:
greet = "cowsay 'Hi!'"
[frontend]
start = "npm run start"
[backend]
start = "docker compose up -d"
Then, just run any of the aliases:
$ judo greet
$ judo frontend:start
$ judo backend:start
Or, have a list of all the available commands in your project:
$ judo
You may also choose to include a .judorc file in your $HOME folder (~/.judorc). Commands defined in this file will always be loaded first and will be overwritten if an overlapping command was found.
Shell completions
To install judo shell completions, execute judo-completions [--apply] {bash|fish|zsh} to get instructions on how to install completions for your shell of choice. By including the --apply option, the installation instructions will be applied for you.
Note: Don't forget to reload your shell session after installation to load the completions.
Development
To contribute to this library, first checkout the code. Then create a new virtual environment:
cd judoka
python -mvenv venv
source venv/bin/activate
Or if you are using pipenv:
pipenv shell
Now install the dependencies and test dependencies:
pip install -e '.[test]'
To run the tests:
pytest
1 Feb 5, 2022
18.6k Dec 30, 2022
1 Dec 10, 2021
2 Jan 4, 2022
75k Jan 2, 2023
184 Jan 7, 2023
19 Jul 20, 2022
19 Jan 21, 2022
3 Oct 26, 2022
1.7k Jan 01, 2023
168 Dec 22, 2022
4 Nov 25, 2021
40 Jan 03, 2023
16 Oct 15, 2022
2.2k Jan 08, 2023
4.8k Dec 30, 2022
2.4k Jan 08, 2023
13.3k Jan 07, 2023
57 Dec 30, 2022
6 Dec 25, 2021
2 Mar 11, 2022
18 Nov 21, 2022
2 Nov 23, 2021
181 Dec 23, 2022
10 Jun 12, 2022
1 Nov 23, 2021
1 Jan 03, 2022
86 Dec 19, 2022