Skip to main content

A utility to remove all docstrings from your project

Project description

strip-docs

PyPI PyPI version PyPI Maintainability Wheel Build status

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

Info-anarchized from this Stack Overflow post

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

Caveats

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.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

strip_docs-1.0-py2.py3-none-any.whl (4.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file strip_docs-1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: strip_docs-1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using 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

File hashes

Hashes for strip_docs-1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4091f73f2bb490a275f90bec264b76da8a5608cd81d99e37ac016badb4913cad
MD5 ac0e18b7deaf8ab2bc4ed69c1869d545
BLAKE2b-256 48f08335c1e020429de0bd72fa4e3876e234c0cf3cb4d5d0faee858d38c5b01d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page