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.

Files for pulpfiction, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size pulpfiction-0.3.0-py3.5.egg (20.0 kB) File type Egg Python version 3.5 Upload date Hashes View
Filename, size pulpfiction-0.3.0-py3-none-any.whl (10.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pulpfiction-0.3.0.tar.gz (4.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page