Skip to main content

A script to remove comments from code.

Project description


$ pip install XComment


Use the project’s CLI to interact with the script.

Processing files

Say, you are working with the file ./tests/sources/HTML/index.html.

Precondition: virtualenv is activated (of course).

To remove comments (output code without comments to output file) invoke

`shell $ comments_remover ./tests/sources/HTML/input.html HTML ./ ` This will take ./tests/sources/HTML/input.html, designated as HTML file, and put the copy of the former (with HTML-specific comments removed, obviously) to ./ named rc.input.html. The latter is the name of the original file prefixed with rc. by default.

To highlight comments (outputs comments only to output file) invoke

$ comments_remover ./tests/sources/HTML/input.html HTML -p ./

Processing directories

If on start been specified directory path, script will be processing directory recursively with all subdirs for sources by specified language.


For processing archived sources use option -a


$ # remove comments
$ comments_remover ./tmp/ -a Python

$ # highlight comments
$ comments_remover ./tmp/ -a -p Python


-l option enable logging (in stdout by default)

-f < path > specify path to log file


$ comments_remover ./tmp/ -l -f ./remove.log Python

Get supported language list

For get list supported languages use -i option. Result list will returned in json format

$ comments_remover -i

["PHP", "Python", "CSS", "HTML", "JavaScript", "ActionScript", "Ruby",
"Assembly", "AppleScript", "Bash", "CSharp", "VB", "XML", "SQL", "C"]

To see full CLI specification, run

$ comments_remover


Getting Up-and-Running Locally

Tested with the following configuration:

  • Ubuntu 16.04 / 17
  • Python 3.6.

Note: the below occurences of `./` refer to the project root unless explicitly stated otherwise.

Setting Things Up on Ubuntu

  1. Enter the shell.

  2. Install pyenv via [pyenv-installer](

    $ curl -L | bash
  3. Follow the instructions on how to initialize pyenv on shell startup, for instance:

    $ echo 'export PATH="/root/.pyenv/bin:$PATH"' >> ~/.bash_profile
    $ echo 'eval "$(pyenv init -)"' >> ~/.bash_profile
    $ echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bash_profile
  4. Install Python 3.6.x via pyenv, say Python 3.6.2 (latest micro release versions are preferred):

    $ pyenv install 3.6.2
  5. Create a virtualenv for the project:

    $ pyenv virtualenv 3.6.2 comments_remover
  6. Switch to whatever directory you wish the project to reside in, say ~:

    $ cd ~
  7. Clone the project from GitHub:
    • either via SSH (the preferred way):
    $ git clone
    • or via HTTPS:
    $ git clone
  8. Switch to the project directory:

    $ cd comments_remover
  9. Activate the virtualenv:

    $ pyenv activate comments_remover
  10. Install project dependencies:

    $ pip install -U -r ./requirements.txt
  11. Install dependencies for testing:

    $ pip install -U -r ./requirements-test.txt
  12. (optional) Install [IPython]( interactive shell to speed up development:

    $ pip install ipython==6.1.0

To run tests, simply

$ pytest ./

To also see coverage report,

pytest --cov ./

You should be good to go now.


Pip registry

Install dependencies

$ python install -r requirements-deploy.txt

Set pypi credentials

$ export TWINE_USERNAME=<pypi username>
$ export TWINE_PASSWORD=<pypi password>

Create distribution

$ python sdist bdist_wheel


$ twine upload dist/XComment-x.y.z.tar.gz


If you’re not using [PyCharm]( yet, make sure to at least consider this as an option. Also check out [JetBrains Toolbox](, a single tool to rule them all (the JetBrains products). To stay up-to-date, follow [PyCharm Blog](

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 XComment, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size XComment-0.0.2.tar.gz (9.6 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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page