https://github.com/codecliff/nocommentspython

Simple yet powerful tool to remove comments from python scripts, with directory recursion
https://github.com/codecliff/nocommentspython

code-cleaning comments docstring documentation python

Last synced: 11 months ago
JSON representation

Simple yet powerful tool to remove comments from python scripts, with directory recursion

• Host: GitHub
• URL: https://github.com/codecliff/nocommentspython
• Owner: codecliff
• License: cc0-1.0
• Created: 2023-10-22T06:23:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-26T16:21:12.000Z (over 2 years ago)
• Last Synced: 2025-01-04T14:43:13.373Z (about 1 year ago)
• Topics: code-cleaning, comments, docstring, documentation, python
• Language: Python
• Homepage: https://github.com/codecliff/NoCommentsPython
• Size: 19.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# NoCommentsPython

A python script to remove comments from python scripts, with directory recursion 

## Features

  1. Removes comments and docstrings

  2. Removes blank lines

  3. Can handle all files in a given directory

  4. Can attach a predefined header text to each output   

  5. Non destructive - writes output to a separate file

## How to use : 

1. **See help :**

    

    `python nocommentspython.py -h`

      

    

 

2. **Specify an input file to strip** 

   

    `python nocommentspython.py -i /path/to/inputfile.py`       

    

    This will create an output file `inputfile.py_sanscomments.py` in the same directory as input file

   

3. **(Optional) Retain header section** 

   

    `python nocommentspython.py -i /path/to/inputfile.py -k yes`       

        

   

4. **(Optional) Specify a header file to insert at the top of output file**

      (Say, for copyright and licenses)

     

     `python nocommentspython.py -i /path/to/inputfile.py -c /path/to/headerfile.txt`

            

5. **Process all files in a directory :**

   

    `python nocommentspython.py -i /path/to/directory`  

    

    This will process each .py file in that directory  and save its respective output file.

    If any input file has an associated header file, it will be duly inserted in its output file (see below).

   

> [!NOTE]

> **Header/Copyright Files: (Automatic headers for output)***

> If an input file is named `abcinput.py`, you can store its header text in a file 

> named `abcinput.py_header.txt` in the same directory.  This text will automatically be inserted in the output. 

> This is specially helpful for processing directories (see above).

© Rahul Singh