Skip to main content

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.



Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pulpfiction-0.3.0-py3.5.egg (20.0 kB) Copy SHA256 hash SHA256 Egg 3.5
pulpfiction-0.3.0-py3-none-any.whl (10.4 kB) Copy SHA256 hash SHA256 Wheel py3
pulpfiction-0.3.0.tar.gz (4.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page