Metadata-Version: 2.0
Name: pulpfiction
Version: 0.2.0
Summary: A simple utility tool to detect non-English comments in code
Home-page: https://github.com/kelvintaywl/pulpfiction
Author: Kelvin Tay
Author-email: kelvintaywl@gmail.com
License: UNKNOWN
Platform: any
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: pygments (>=2.2.0)
Requires-Dist: langdetect (>=1.0.7)
Requires-Dist: click (>=6.7)
Provides-Extra: dev
Requires-Dist: flake8 (>=3.5.0); extra == 'dev'

# Pulp Fiction

<div align="center">
  <img src="./images/jules.png" width="256" height="256" alt="Jules Winnfield art by icassu">
</div>

_(English, *****! Do you speak it?)_

A simple tool to detect non-English commments in a code base (directory).

Inspired by the fictional character, [Jules Winnfield, played by Samuel L Jackson in the film, Pulp Fiction](https://www.urbandictionary.com/define.php?term=Jules%20Winnfield).

## Install

```shell
# requires Python3
$ pip install pulpfiction

## Usage

```shell
$ jules --help

Usage: jules [OPTIONS]

  Simple tool to detect non-English commments in a code base..

Options:
  --path TEXT           path to project or repository
  --help                Show this message and exit.
```

```shell
# by default, it looks at the current directory or $PWD
# alternatively,
$ jules --path=~/personal/my-awesome-git-project
```

Script exits with `sys.exit(0)` if successful, else the earliest invalid comment is found and raised.



