# 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/language/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 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](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
Raw data
{
"_id": null,
"home_page": "https://github.com/Safe-DS/Stub-Generator",
"name": "safe-ds-stubgen",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "data-science, machine-learning, dsl",
"author": "Lars Reimann",
"author_email": "mail@larsreimann.com",
"download_url": "https://files.pythonhosted.org/packages/07/00/112b8e8651636d6d97e2c1c2fcb30f38ecff93c61a6f7877a2c3f0725f30/safe_ds_stubgen-0.2.0.tar.gz",
"platform": null,
"description": "# Stub Generator\n\n[](https://pypi.org/project/safe-ds-stubgen)\n[](https://github.com/Safe-DS/Stub-Generator/actions/workflows/main.yml)\n[](https://codecov.io/gh/Safe-DS/Stub-Generator)\n[](https://stubgen.safeds.com)\n\nAutomated generation of [Safe-DS stubs](https://dsl.safeds.com/en/stable/language/stub-language/) for Python libraries.\n\n## Installation\n\nGet the latest version from [PyPI](https://pypi.org/project/safe-ds-stubgen):\n\n```shell\npip install safe-ds-stubgen\n```\n\n## Usage\n\nTo run this program:\n\n```txt\nusage: safe-ds-stubgen [-h] [-v] -p PACKAGE [-s SRC] -o OUT [--docstyle {PLAINTEXT,EPYDOC,GOOGLE,NUMPYDOC,REST}] [-tr] [-nc]\n\nAnalyze Python code.\n\noptions:\n -h, --help show this help message and exit\n -v, --verbose show info messages\n -p PACKAGE, --package PACKAGE\n The name of the package.\n -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.\n -o OUT, --out OUT Output directory.\n --docstyle {PLAINTEXT,EPYDOC,GOOGLE,NUMPYDOC,REST}\n The docstring style.\n -tr, --testrun Set this flag if files in /test or /tests directories should be included.\n -nc, --naming_convert\n Set this flag if the name identifiers should be converted to Safe-DS standard (UpperCamelCase for classes and camelCase for everything else).\n```\n\n## Documentation\n\nYou can find the full documentation [here](https://stubgen.safeds.com).\n\n## Contributing\n\nWe welcome contributions from everyone. As a starting point, check the following resources:\n\n* [Setting up a development environment](https://stubgen.safeds.com/en/latest/development/environment/)\n* [Project guidelines](https://stubgen.safeds.com/en/latest/development/project_guidelines/)\n* [Contributing page](https://github.com/Safe-DS/Stub-Generator/contribute)\n\nIf you need further help, please [use our discussion forum][forum].\n\n[forum]: https://github.com/orgs/Safe-DS/discussions\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generation of Safe-DS stubs for Python libraries.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://stubgen.readthedocs.io",
"Homepage": "https://github.com/Safe-DS/Stub-Generator",
"Repository": "https://github.com/Safe-DS/Stub-Generator"
},
"split_keywords": [
"data-science",
" machine-learning",
" dsl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c75c82bde014f783fe3a6bd4d4f9f0daafec4b41e9103182a93da530585ef5b",
"md5": "e972bfe6941e23b998c50912fe324e7a",
"sha256": "5a2135b2912e23748ebd1acd6ca10e8393e2fab900ab60da2daccc95275218f3"
},
"downloads": -1,
"filename": "safe_ds_stubgen-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e972bfe6941e23b998c50912fe324e7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 50882,
"upload_time": "2024-03-29T13:15:51",
"upload_time_iso_8601": "2024-03-29T13:15:51.978626Z",
"url": "https://files.pythonhosted.org/packages/4c/75/c82bde014f783fe3a6bd4d4f9f0daafec4b41e9103182a93da530585ef5b/safe_ds_stubgen-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0700112b8e8651636d6d97e2c1c2fcb30f38ecff93c61a6f7877a2c3f0725f30",
"md5": "3a167ed304c8fdcbd674be8bac4b37d9",
"sha256": "0892d2f9e5c91812ee6faeef2254a89c4219ddfb71e09fed7c4a0b2685283b71"
},
"downloads": -1,
"filename": "safe_ds_stubgen-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3a167ed304c8fdcbd674be8bac4b37d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 39329,
"upload_time": "2024-03-29T13:15:53",
"upload_time_iso_8601": "2024-03-29T13:15:53.631512Z",
"url": "https://files.pythonhosted.org/packages/07/00/112b8e8651636d6d97e2c1c2fcb30f38ecff93c61a6f7877a2c3f0725f30/safe_ds_stubgen-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 13:15:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Safe-DS",
"github_project": "Stub-Generator",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "safe-ds-stubgen"
}
JSON
