Python Gimmicks (pygim)

Python Gimmicks is a library that contains magical but useful tools that can be used to improve productivity of any Python project. The goal is to use whatever Pythonic means to provide as light-weight and high-performance solutions as possible.

Installation

To install this project, simply write the following command:

$ pip install pygim

Command Line Interface

Installing the package also exposes a pygim command that wraps the project's housekeeping helpers. Run pygim --help to see the available sub-commands, including quick clean-up tools and a shortcut for running the coverage workflow used in this repository.

$ pygim clean-up --all --yes
Starting clean up in `/your/project/path`
Excellent! You never see them again!

You can also trigger the test coverage routine in one line:

$ pygim show-test-coverage

Both commands accept the same flags described in pygim --help, so you can mix and match automation-friendly options (like --quiet or --yes) to fit your workflow.

Sub-modules

This library is divided into multiple different smaller packages.

• pygim: This is the main project that contains the CLI and all the examples.

Changelog

See the detailed list of changes in CHANGELOG.rst. For upcoming (unreleased) work, consult the top "Unreleased" section before the next version tag.