Adds docstrings to your type stubs.
Project description
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.txtto do an editable install - Run
pytestto 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/*
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
stubdocs-0.0.0.tar.gz
(3.2 kB
view details)
Built Distribution
File details
Details for the file stubdocs-0.0.0.tar.gz.
File metadata
- Download URL: stubdocs-0.0.0.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5ef409bc000027c4c282bb4f2a35671c820199a69e85c9b801950622db8e8c4e |
|
| MD5 | 764d35f64bfaaa293a427385d74fa809 |
|
| BLAKE2b-256 | 97cbd2183e309ffb1534430be7e9bb353ced1b63bbfecb6a39c73c85a9c2a8bc |
File details
Details for the file stubdocs-0.0.0-py3-none-any.whl.
File metadata
- Download URL: stubdocs-0.0.0-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fce6ef22b5a7831ee0f77edb9379e7efc4040aa939de88ef0d7996d82449b72e |
|
| MD5 | 7669b8f76fc4ef6d3bb4e81f4baf4d74 |
|
| BLAKE2b-256 | f3e1b555ded69a8924c1425ec5e414b94c389b468114a8ea5ce39fb6a15ae6b9 |
