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/*
1 maintainer
Metadata
1 maintainer
Release files for stubdocs 0.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| stubdocs-0.0.0.tar.gz | 3.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| stubdocs-0.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.1 kB
Release files / stubdocs-0.0.0.tar.gz
| Download URL | stubdocs-0.0.0.tar.gz |
|---|---|
| Size | 3.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5ef409bc000027c4c282bb4f2a35671c820199a69e85c9b801950622db8e8c4e
|
|
BLAKE2b-256 checksum How to use checksums |
97cbd2183e309ffb1534430be7e9bb353ced1b63bbfecb6a39c73c85a9c2a8bc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
Release files / stubdocs-0.0.0-py3-none-any.whl
| Download URL | stubdocs-0.0.0-py3-none-any.whl |
|---|---|
| Size | 3.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fce6ef22b5a7831ee0f77edb9379e7efc4040aa939de88ef0d7996d82449b72e
|
|
BLAKE2b-256 checksum How to use checksums |
f3e1b555ded69a8924c1425ec5e414b94c389b468114a8ea5ce39fb6a15ae6b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
