Skip to main content

Standardized project tool for running common tasks

Project description

# This - Standardized project tool

[![Travis branch](https://img.shields.io/travis/iBelieve/this/master.svg?style=for-the-badge)](https://travis-ci.org/iBelieve/this) [![PyPI](https://img.shields.io/pypi/v/this-cli.svg?style=for-the-badge)](https://pypi.org/project/this-cli/) [![PyPI - License](https://img.shields.io/pypi/l/this-cli.svg?style=for-the-badge)](https://opensource.org/licenses/MIT) [![Maintenance](https://img.shields.io/maintenance/yes/2018.svg?style=for-the-badge)]()

this provides a standardized and simplified interface for running many common project tasks, such as building, running, testing, and deploying. It supports many project types, including Node.js, Python, Autotools, Meson, and CMake.

By providing a standard set of commands, the goal is to ease the burden of having to remember or look up the exact commands to run for specific projects. In addition, this will run multiple commands as necessary to accomplish a given task. For example, building an autotools-based project will run ./autogen.sh, ./configure, then make, while a meson-based project will run meson and then ninja in the build directory.

The goal of this is not to provide every possible feature or command, but only to wrap a subset of commands common to most projects. For more advanced commands, use the actual commands that this wraps.

### Installation and Usage

this is currently available via pip3 (Python 3-only):

pip3 install this-cli

To use on a project, you can directly invoke this with one of the commands listed below, or run this with no arguments to see what project type is detected and what subset of the commands are available:

> this

Node.js project using Yarn (deployed using Ansible)

Available commands:

build lint test check run deploy

To see what steps this will run for a given command, use the –dry-run flag:

> this –dry-run deploy

$ ansible-galaxy install -r ansible/requirements.yml $ ansible-playbook -i ansible/inventory ansible/playbook.yml

### Supported Project Formats

  • Autotools

  • Cargo (Rust)

  • CMake

  • Makefile

  • Meson

  • Node.js

  • Python

### Supported Commands

  • build

  • lint

  • test

  • check (usually lint + test combined)

  • run

  • deploy

### License

Licensed under the [MIT license](https://opensource.org/licenses/MIT).

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

this-cli-0.2.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

this_cli-0.2-py3-none-any.whl (13.4 kB view hashes)

Uploaded Python 3

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