# CVLDoc
parse NatSpec comments from a spec file(s) and save them in a JSON file.
## usage
CVLDoc.exe [-h] [-v] [-dev] [-user] [--version]
input_file [input_file ...]
argument:
input_file - the input spec file to analyze, there can be more than one
### options:
-h, --help - display help message and exit.
-v, --verbosity - increase output verbosity
--version - show program version and exit
The tool invoke the netspec parser and will generate a JSON file that contains all the
# Testing
In order to test the JSON generator run simply:
python natspec_tests.py
This will run a series of spec file as input and compare the
resulted json with the expected json result.
Any differences will be reported to the standard outputs.
## Notes
1. Every input file will generate a JSON file, with the same name, at the same folder, different extension.
2. If the parser or the conversion process will encounter one or more problems, the error messages will be displayed on the standard output
3. Not all NatSpec tags and required error messages are supported in this version.
Raw data
{
"_id": null,
"home_page": "https://github.com/Certora/natspecTools",
"name": "CVLDoc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Certora CVLDoc",
"author": "Certora ltd",
"author_email": "support@certora.com",
"download_url": "https://files.pythonhosted.org/packages/74/d3/c7fe1c4b9e6cdda43060e80c84aaba9aff4becbc430eb74251c429162bb1/CVLDoc-1.0.1.tar.gz",
"platform": null,
"description": "# CVLDoc\nparse NatSpec comments from a spec file(s) and save them in a JSON file.\n\n## usage\n\nCVLDoc.exe [-h] [-v] [-dev] [-user] [--version]\n input_file [input_file ...]\n\nargument:\ninput_file - the input spec file to analyze, there can be more than one\n### options:\n-h, --help - display help message and exit.\n-v, --verbosity - increase output verbosity\n--version - show program version and exit\n\nThe tool invoke the netspec parser and will generate a JSON file that contains all the \n\n# Testing\nIn order to test the JSON generator run simply:\n python natspec_tests.py\nThis will run a series of spec file as input and compare the \nresulted json with the expected json result.\nAny differences will be reported to the standard outputs.\n\n## Notes\n\n1. Every input file will generate a JSON file, with the same name, at the same folder, different extension.\n 2. If the parser or the conversion process will encounter one or more problems, the error messages will be displayed on the standard output\n 3. Not all NatSpec tags and required error messages are supported in this version.\n\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Utility for reading CERTORA spec files, parse and export their NatSpec comments to JSON files.",
"version": "1.0.1",
"split_keywords": [
"certora",
"cvldoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c4f2bdcec426402699c137e70212e0304a34f520efe98af67aa36de94bcb6ce",
"md5": "1460042dbddf23e27c14b14eddb42b23",
"sha256": "780f24db899fb5ee143386350c5fe538c8b69eb6d4b00e2d8da40363eb27119a"
},
"downloads": -1,
"filename": "CVLDoc-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1460042dbddf23e27c14b14eddb42b23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11484,
"upload_time": "2023-01-15T09:44:02",
"upload_time_iso_8601": "2023-01-15T09:44:02.821601Z",
"url": "https://files.pythonhosted.org/packages/2c/4f/2bdcec426402699c137e70212e0304a34f520efe98af67aa36de94bcb6ce/CVLDoc-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74d3c7fe1c4b9e6cdda43060e80c84aaba9aff4becbc430eb74251c429162bb1",
"md5": "3d19ae2cd3af8610450625ad3e207e73",
"sha256": "3f07caa550fb9b9130344f94d37f3c66a432b919dfb4baa7f321c2e7b388e405"
},
"downloads": -1,
"filename": "CVLDoc-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3d19ae2cd3af8610450625ad3e207e73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8036,
"upload_time": "2023-01-15T09:44:03",
"upload_time_iso_8601": "2023-01-15T09:44:03.877426Z",
"url": "https://files.pythonhosted.org/packages/74/d3/c7fe1c4b9e6cdda43060e80c84aaba9aff4becbc430eb74251c429162bb1/CVLDoc-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-15 09:44:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Certora",
"github_project": "natspecTools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "cvldoc"
}
JSON
