| Name | morast JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | |
| Summary | MOdule Reference by Analyzing the Syntax Tree |
| upload_time | 2024-03-16 20:03:39 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 Rainer Schwarzbach Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ast
documentation
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MOdule Reference by Analyzing the Syntax Tree
_Create reference documentation from sources using AST_
```
pip install morast
```
Installation in a virtual environment is strongly recommended.
## Usage
Output of `python3 -m morast --help`:
```
usage: morast [-h] [--version] [-d | -v | -q] {auto,extract,init,config,module} ...
Create reference documentation from sources using AST
positional arguments:
{auto,extract,init,config,module}
auto automatically detect and document all modules
extract extract override templates from modules
init initialize the MoRAST project
config show the configuration
module document a single module
options:
-h, --help show this help message and exit
--version print version and exit
Logging options:
control log level (default is WARNING)
-d, --debug output all messages (log level DEBUG)
-v, --verbose be more verbose (log level INFO)
-q, --quiet be more quiet (log level ERROR)
```
## Further reading
Please see the documentation at <https://blackstream-x.gitlab.io/morast>
for detailed usage information.
If you found a bug or have a feature suggestion,
please open an issue [here](https://gitlab.com/blackstream-x/morast/-/issues)
Raw data
{
"_id": null,
"home_page": "",
"name": "morast",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "ast,documentation",
"author": "",
"author_email": "Rainer Schwarzbach <rainer@blackstream.de>",
"download_url": "https://files.pythonhosted.org/packages/9c/ff/9c30b8d7ff8b096c1d0f23859cbfec342a57174e61d499de2dbdeabe249d/morast-0.3.1.tar.gz",
"platform": null,
"description": "# MOdule Reference by Analyzing the Syntax Tree\n\n_Create reference documentation from sources using AST_\n\n```\npip install morast\n```\n\nInstallation in a virtual environment is strongly recommended.\n\n\n## Usage\n\nOutput of `python3 -m morast --help`:\n\n```\nusage: morast [-h] [--version] [-d | -v | -q] {auto,extract,init,config,module} ...\n\nCreate reference documentation from sources using AST\n\npositional arguments:\n {auto,extract,init,config,module}\n auto automatically detect and document all modules\n extract extract override templates from modules\n init initialize the MoRAST project\n config show the configuration\n module document a single module\n\noptions:\n -h, --help show this help message and exit\n --version print version and exit\n\nLogging options:\n control log level (default is WARNING)\n\n -d, --debug output all messages (log level DEBUG)\n -v, --verbose be more verbose (log level INFO)\n -q, --quiet be more quiet (log level ERROR)\n```\n\n\n## Further reading\n\nPlease see the documentation at <https://blackstream-x.gitlab.io/morast>\nfor detailed usage information.\n\nIf you found a bug or have a feature suggestion,\nplease open an issue [here](https://gitlab.com/blackstream-x/morast/-/issues)\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Rainer Schwarzbach Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "MOdule Reference by Analyzing the Syntax Tree",
"version": "0.3.1",
"project_urls": {
"Bug Tracker": "https://gitlab.com/blackstream-x/morast/-/issues",
"CI": "https://gitlab.com/blackstream-x/morast/-/pipelines",
"Documentation": "https://blackstream-x.gitlab.io/morast",
"Homepage": "https://gitlab.com/blackstream-x/morast",
"Repository": "https://gitlab.com/blackstream-x/morast.git"
},
"split_keywords": [
"ast",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f92eee8fd5aad58442f0b2509f423fd360512a6bad7f8066344b50ad966127cd",
"md5": "cccc1726dca47105578f87edc5388ef2",
"sha256": "fdd011f719ccab69544295a47ce9d7f7caa75bf40529a8f2cfff45d1b69caefb"
},
"downloads": -1,
"filename": "morast-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cccc1726dca47105578f87edc5388ef2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 32731,
"upload_time": "2024-03-16T20:03:37",
"upload_time_iso_8601": "2024-03-16T20:03:37.591694Z",
"url": "https://files.pythonhosted.org/packages/f9/2e/ee8fd5aad58442f0b2509f423fd360512a6bad7f8066344b50ad966127cd/morast-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9cff9c30b8d7ff8b096c1d0f23859cbfec342a57174e61d499de2dbdeabe249d",
"md5": "9a3f620384b45663477fdc1bbc8fa68d",
"sha256": "567b59e26ada6b1ec824c1fd3eca28bbab6fe0560ed62f63d311e782275b5830"
},
"downloads": -1,
"filename": "morast-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "9a3f620384b45663477fdc1bbc8fa68d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 34254,
"upload_time": "2024-03-16T20:03:39",
"upload_time_iso_8601": "2024-03-16T20:03:39.527900Z",
"url": "https://files.pythonhosted.org/packages/9c/ff/9c30b8d7ff8b096c1d0f23859cbfec342a57174e61d499de2dbdeabe249d/morast-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-16 20:03:39",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "blackstream-x",
"gitlab_project": "morast",
"lcname": "morast"
}
