strip-docs

A Python utility to remove all docstrings from your modules before shipping

Usage

Just install it via pip

pip install strip-docs

And then launch it on any list of files or directories that you would like to see the docstrings gone, this way:

strip-docs dir1 dir2 file1 file2 ...

All .py, .pyx and .pxd files will be processed.

If you specify a single file, it will be processed

Try to avoid writing empty classes or routines like this:

def empty_routine():
    """I am an empty routine"""

Because the syntax itself is not analyzed, this will result in a Python SyntaxError.

Better write this:

def empty_routine():
    """I am an empty routine"""
    ...

So after trimming the docstrings it remains valid Python.

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Table of built distributions (wheels) for strip-docs 1.0
File	Interpreter	ABI	Platform	Reset
strip_docs-1.0-py2.py3-none-any.whl 4.5 kB Dec 20, 2020	Python 3, Python 2	none	any	Details

Download URL	strip_docs-1.0-py2.py3-none-any.whl
Size	4.5 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`4091f73f2bb490a275f90bec264b76da8a5608cd81d99e37ac016badb4913cad`
BLAKE2b-256 checksum How to use checksums	`48f08335c1e020429de0bd72fa4e3876e234c0cf3cb4d5d0faee858d38c5b01d`
Upload date	Dec 20, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.8.0`