A simple utility tool to detect non-English comments in code
Project description
*****
PulpFiction
*****
.. image:: ./images/jules.png
*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
#######
.. code-block:: bash
# requires Python3
$ pip install pulpfiction
Usage
#####
.. code-block:: bash
$ 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.
.. code-block:: bash
# 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.
Known Issues
############
- Commented-out code will be considered non-English; false positive.
PulpFiction
*****
.. image:: ./images/jules.png
*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
#######
.. code-block:: bash
# requires Python3
$ pip install pulpfiction
Usage
#####
.. code-block:: bash
$ 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.
.. code-block:: bash
# 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.
Known Issues
############
- Commented-out code will be considered non-English; false positive.
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.3.0.tar.gz
(4.1 kB
view hashes)
Built Distributions
pulpfiction-0.3.0-py3.5.egg
(20.0 kB
view hashes)
Close
Hashes for pulpfiction-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a882be50d96912dba14c97f92178a2350a73f0f0b7377359ca98700196a17226 |
|
MD5 | 2e426ed4b80e0d043ef133ea74809362 |
|
BLAKE2b-256 | 3f9c606bf928d446a3f86df21fa624790c48d6110553de77763630eca0400ae7 |