https://github.com/safe-ds/stub-generator
Automated generation of Safe-DS stubs for Python libraries.
https://github.com/safe-ds/stub-generator
data-science dsl machine-learning
Last synced: about 1 year ago
JSON representation
Automated generation of Safe-DS stubs for Python libraries.
- Host: GitHub
- URL: https://github.com/safe-ds/stub-generator
- Owner: Safe-DS
- License: mit
- Created: 2023-07-05T14:59:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-19T03:12:49.000Z (about 1 year ago)
- Last Synced: 2025-06-20T13:19:25.146Z (about 1 year ago)
- Topics: data-science, dsl, machine-learning
- Language: Python
- Homepage: https://stubgen.safeds.com
- Size: 96.2 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Stub Generator
[](https://pypi.org/project/safe-ds-stubgen)
[](https://github.com/Safe-DS/Stub-Generator/actions/workflows/main.yml)
[](https://codecov.io/gh/Safe-DS/Stub-Generator)
[](https://stubgen.safeds.com)
Automated generation of [Safe-DS stubs](https://dsl.safeds.com/en/stable/stub-language/) for Python libraries.
## Installation
Get the latest version from [PyPI](https://pypi.org/project/safe-ds-stubgen):
```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](https://stubgen.safeds.com).
## Contributing
We welcome contributions from everyone. As a starting point, check the following resources:
* [Setting up a development environment](https://stubgen.safeds.com/en/latest/development/environment/)
* [Project guidelines](https://stubgen.safeds.com/en/latest/development/project_guidelines/)
* [Contributing page](https://github.com/Safe-DS/Stub-Generator/contribute)
If you need further help, please [use our discussion forum][forum].
[forum]: https://github.com/orgs/Safe-DS/discussions