{ "info": { "author": "Edouard DUPIN", "author_email": "yui.heero@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Topic :: Software Development :: Build Tools", "Topic :: Software Development :: Documentation", "Topic :: Software Development :: Testing" ], "description": "Prude\n=====\n\n`prude` is a generic code annalyser to check ```language``` error. The ```language``` check is the english.\n\n[![Badge](https://badge.fury.io/py/prude.png](https://pypi.python.org/pypi/prude)\n\n\nInstructions\n------------\n\nThis is a tool to annalyse C, C++ file and determine if it have some english word that does not exist.\n\n\nPrude is under a FREE license that can be found in the COPYING file.\nAny contribution is more than welcome ;)\n\ngit repository\n--------------\n\nhttp://github.com/HeeroYui/prude/\n\nInstallation\n------------\n\nRequirements: ``Python >= 2.7`` and ``pip``\n\nJust run:\n```\npip install prude\n```\n\nInstall pip on debian/ubuntu:\n```\nsudo apt-get install pip\n```\n\nInstall pip on ARCH-linux:\n```\nsudo pacman -S pip\n```\n\nInstall pip on MacOs:\n```\nsudo easy_install pip\n```\n\ndeveloppement for prude:\n```\ngit clone http://github.com/HeeroYui/prude/\ncd prude\n./setup.py develop --user\n```\n\nDocumentation\n-------------\n\nUsage\n******\n\nGo to your coding directory and execute:\n```\n prude yourFileToParce.cpp\n # OR (multiple files)\n prude yourFileToParce.cpp other_file.py and.txt\n # simply the path\n prude .\n```\n\nYou can use some options:\n```\n --color/-C to have beautifull color check\n --recursive/-r Parse all under directories\n```\n\nCreate exceptions:\n******************\n\nprude parse all upper folder to find all file \".prude_*\" and add it in the list of exceptions error.\n\nThe search end when find the file \".prude\".\n\nyou can have:\n```\n root_path\n --> .prude\n --> .prude_lua\n --> .prude_tinyxml\n --> module\n --> submodule\n --> .prude_local\n --> .prude_local2\n --> my_file_cpp.cpp\n --> sub_second\n --> file_c.c\n```\n\nThe check of the file ```my_file_cpp.cpp``` use all the .prude* file and the file ```file_c.c``` only use the file on the root_path\n\nA prude file is contituated like:\n\n * ```#``` Comment the line\n * ```+``` Use the end of the line to check the exact match of the string (ex: +MY_VariableStupidName)\n * direct element is use to comare each word in lower case to exclude error on it (ex: destructor)\n * ```!``` Command to apply at the configuration.\n - ```!NO_CAPITAL_LETTER``` ==> disable the check of the word in capital letter\n - ```!CAPITAL_LETTER``` ==> enable the check of the word in capital letter (default)\n\nSome tricky things (removed because it is errored at the declaration and no more need in library using it):\n\n * The namespace call are disable (ex namespace::prout)\n * The parameter access are disable (ex: variable.hello() or variable->hello())\n * The \"#include ...\" and the \"# include ...\"\n\nNow you can play.\n\nNote: in the http://github.com/HeeroYui/prude/common/ you have some common C library that declare stupid thing in global...\n\nLicense (APACHE v2.0)\n---------------------\n\nCopyright prude Edouard DUPIN\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/HeeroYui/prude", "keywords": "language checker in code", "license": "APACHE-2", "maintainer": "", "maintainer_email": "", "name": "prude", "package_url": "https://pypi.org/project/prude/", "platform": "", "project_url": "https://pypi.org/project/prude/", "project_urls": { "Homepage": "http://github.com/HeeroYui/prude" }, "release_url": "https://pypi.org/project/prude/0.3.2/", "requires_dist": null, "requires_python": "", "summary": "Prude is a simple parser that check word error (CamelCase variable, snake_case variable and Documentation)", "version": "0.3.2" }, "last_serial": 5745873, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "426c22ca86df367521eae952cfb9236f", "sha256": "2eafb7f012d1744273240adbd486f6e3e0edaf65d8a7867ebe836918970182ec" }, "downloads": -1, "filename": "prude-0.2.0.tar.gz", "has_sig": false, "md5_digest": "426c22ca86df367521eae952cfb9236f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 499622, "upload_time": "2017-09-07T05:35:33", "url": "https://files.pythonhosted.org/packages/e2/ba/5b8dab1b17c15e6cd18a08a0b707351939f1f01a6044cd2057ab1fb3ce49/prude-0.2.0.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "c10e182e6c44172a87b0f0bd0b2c0e82", "sha256": "e8c6e41c0402ec055ab96f64837ae5a47ac50ce9f2a8d7a5bc027c4b84f0ef3e" }, "downloads": -1, "filename": "prude-0.3.2.tar.gz", "has_sig": false, "md5_digest": "c10e182e6c44172a87b0f0bd0b2c0e82", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 500222, "upload_time": "2019-08-28T21:23:51", "url": "https://files.pythonhosted.org/packages/ad/aa/8123f4389e3cae362f992830e51363a940f9a3c14737a8dc46a457603dcc/prude-0.3.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c10e182e6c44172a87b0f0bd0b2c0e82", "sha256": "e8c6e41c0402ec055ab96f64837ae5a47ac50ce9f2a8d7a5bc027c4b84f0ef3e" }, "downloads": -1, "filename": "prude-0.3.2.tar.gz", "has_sig": false, "md5_digest": "c10e182e6c44172a87b0f0bd0b2c0e82", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 500222, "upload_time": "2019-08-28T21:23:51", "url": "https://files.pythonhosted.org/packages/ad/aa/8123f4389e3cae362f992830e51363a940f9a3c14737a8dc46a457603dcc/prude-0.3.2.tar.gz" } ] }