Stub Generator

Automated generation of Safe-DS stubs for Python libraries.

Installation

Get the latest version from PyPI:

shell pip install safe-ds-stubgen

Usage

To run this program:

```txt 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 Source directory containing the Python code of the package. -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:

• Setting up a development environment
• Project guidelines
• Contributing page

If you need further help, please use our discussion forum.