Skip to main content

Set alias to long commands and speed up your workflow.

Project description

Chuy

CodeQL PyTest Pylint Code Style PyPi Version Repo Size License: MIT Lines of Code

Set alias to long commands and speed up your workflow, inspired in tools like yarn and npm.

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 from PyPI like any other package:

pip install chuy

To get the last version:

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 format:

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

Example: chuy.json

Using TOML format:

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

Example: chuy.toml

Using pyproject.toml file:

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

Example: pyproject.toml

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 chuy.json file, you can now execute them as follows:

chuy format
 $ poetry run black .
 ....

This varies depending on the commands you have written in the chuy file.

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

You can also pass multiple commands:

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.

If you want to integrate this tool with Poetry, try: UltiRequiem/poetry-chuy-plugin

Screenshots

Normal usage:

Screenshot Normal Usage

And if you don't pass any command:

Screenshot Menu

License

Chuy is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chuy-1.4.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

chuy-1.4.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file chuy-1.4.0.tar.gz.

File metadata

  • Download URL: chuy-1.4.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Linux/5.13.13-arch1-1

File hashes

Hashes for chuy-1.4.0.tar.gz
Algorithm Hash digest
SHA256 203e646b20fe8eb1029a11596323f4595e6869c3ec01a1782fd7abb702e36abc
MD5 7243f5e5def5fa5e4b21973bde723296
BLAKE2b-256 b7fc80486a757119dedc6819f023baf8545912210a6f56df2d7b9a6d66ce6b8b

See more details on using hashes here.

File details

Details for the file chuy-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: chuy-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Linux/5.13.13-arch1-1

File hashes

Hashes for chuy-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2fe7948f8f90c101bcfddc52e7e1ab873fca63024ad31defd5aeb39ad0d284dd
MD5 de0fbe809eae79636325528c5469324d
BLAKE2b-256 d297dbc35a43f646f98077476eb240f900ebb02ff990110cee0ad36fdf307b4b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page