stubdocs 0.0.0

Adds docstrings to your type stubs.

stubdocs

Adds docstrings to your type stubs.

Installation

pip install stubdocs

Usage

$ stubdocs . --stub-dir stubs
rewrote stub stubs/mypackage/foo.pyi using docstrings in mypackage/foo.py
rewrote stub stubs/mypackage/bar/baz.pyi using docstrings in mypackage/bar/baz.py

Local Development / Testing

• Create and activate a virtual environment
• Run pip install -r requirements-dev.txt to do an editable install
• Run pytest to run tests

Type Checking

Run mypy .

Create and upload a package to PyPI

Make sure to bump the version in setup.cfg.

Then run the following commands:

rm -rf build dist
python setup.py sdist bdist_wheel

Then upload it to PyPI using twine:

twine upload dist/*