Generation of Safe-DS stubs for Python libraries.
Project description
Stub Generator
Automated generation of Safe-DS stubs for Python libraries.
Installation
Get the latest version from PyPI:
pip install safe-ds-stubgen
Usage
To run this program:
usage: safe-ds-stubgen [-h] [-v] -p PACKAGE [-s SRC] -o OUT [--docstyle {PLAINTEXT,EPYDOC,GOOGLE,NUMPYDOC,REST}] [-tr] [-nc]
Analyze Python code.
options:
-h, --help show this help message and exit
-v, --verbose show info messages
-p PACKAGE, --package PACKAGE
The name of the package.
-s SRC, --src SRC Directory containing the Python code of the package. If this is omitted, we try to locate the package with the given name in the current Python interpreter.
-o OUT, --out OUT Output directory.
--docstyle {PLAINTEXT,EPYDOC,GOOGLE,NUMPYDOC,REST}
The docstring style.
-tr, --testrun Set this flag if files in /test or /tests directories should be included.
-nc, --naming_convert
Set this flag if the name identifiers should be converted to Safe-DS standard (UpperCamelCase for classes and camelCase for everything else).
Documentation
You can find the full documentation here.
Contributing
We welcome contributions from everyone. As a starting point, check the following resources:
If you need further help, please use our discussion forum.
Project details
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
safe_ds_stubgen-0.2.0.tar.gz
(39.3 kB
view hashes)
Built Distribution
Close
Hashes for safe_ds_stubgen-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a2135b2912e23748ebd1acd6ca10e8393e2fab900ab60da2daccc95275218f3 |
|
MD5 | e972bfe6941e23b998c50912fe324e7a |
|
BLAKE2b-256 | 4c75c82bde014f783fe3a6bd4d4f9f0daafec4b41e9103182a93da530585ef5b |