A simple utility tool to detect non-English comments in code
Project description
# 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.
<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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pulpfiction-0.1.0.tar.gz
(3.6 kB
view hashes)
Built Distributions
pulpfiction-0.1.0-py3.5.egg
(19.2 kB
view hashes)
Close
Hashes for pulpfiction-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e92600a2ef7cea183380f98eadbe09e82d6080074772f07f8f20ba3e71548bd |
|
MD5 | c24e91d0d59e886290f54932296b5321 |
|
BLAKE2b-256 | a0233ccf4c89442d5b596a5b5467b1239f2f4d5a966f60e140e9ecbefc184a76 |