chuy

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 13 Open GitHub ↗

🐻 Set alias to long commands and speed up your workflow! Support for JSON , TOML and INI configs file format and integrates with Poetry.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Chuy

![CodeQL](https://github.com/UltiRequiem/chuy/workflows/CodeQL/badge.svg)
![CI](https://github.com/UltiRequiem/chuy/workflows/CI/badge.svg)
[![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000.svg)](https://github.com/psf/black)
[![PyPi Version](https://img.shields.io/pypi/v/chuy)](https://pypi.org/project/chuy)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Lines of Code](https://img.shields.io/tokei/lines/github.com/UltiRequiem/chuy?color=blue&label=Total%20Lines)

Set alias to long commands and speed up your workflow, inspired in tools like
[yarn](https://github.com/yarnpkg/berry) and [npm](https://github.com/npm/cli).

Although Chuy is written in Python, it can be used for projects of any language,
and even folders that are not projects!

**Note:** this tool is actively used by its primary author. He's happy to review
pull requests / respond to issues you may discover.

## Install

You can install [Chuy](https://pypi.org/project/chuy) from PyPI like any other
package:

```bash
pip install chuy
```

To get the last version:

```bash
pip install git+https://github.com/UltiRequiem/chuy
```

If you use Linux, you may need to install this with sudo to be able to access
the command throughout your system.

## Example Configuration file

Using [`JSON`](./chuy.json) format:

```json
{
  "format": "poetry run black .",
  "lint": "poetry run pylint chuy tests",
  "tests": "poetry run pytest",
  "package": "poetry build && poetry publish"
}
```

Using [`TOML`](./chuy.toml) format:

```toml
[chuy]
format = "poetry run black ."
lint = "poetry run pylint chuy tests"
tests = "poetry run pytest"
package = "poetry build && poetry publish"
```

Using the [`pyproject.toml`](./pyproject.toml) file:

```toml
[tool.chuy]
format = "poetry run black ."
lint = "poetry run pylint chuy tests"
tests = "poetry run pytest"
package = "poetry build && poetry publish"
```

Usually the configuration file goes in the root of your project but it can
really go anywhere.

## Usage

After having defined the commands in the
[configuration file](#example-configuration-file), you can now execute them as
follows:

```bash
chuy format
 $ poetry run black .
 ....
```

This varies depending on the commands you have written in the
[chuy file](#example-configuration-file).

```bash
chuy lint
 $ poetry run pylint chuy tests
 ....
```

You can also pass multiple commands:

```bash
chuy lint format tests
 $ poetry run pylint chuy tests
 ....

$ poetry run black .
 ....

$ poetry run pytest
 ....
```

## Tricks

If you do not pass any command, you will get a menu with all the available
commands, then you will be asked which of them you want to execute, here you can
pass more than one command if you want.

## Screenshots

Normal usage:

![Screenshot Normal Usage](https://i.imgur.com/sOu86gu.png)

And if you don't pass any command:

![Screenshot Menu](https://i.imgur.com/nFd4Bz9.png)

## License

This project is licensed under the [MIT License](./LICENSE).

chuy

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README