{ "info": { "author": "Mohammad Albakri", "author_email": "mohammad.albakri93@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "

\n \n

\n\n

\n \"Build\n \"Downloads\"\n

\n\nDYC is a CLI tool that helps with documenting your source code. It will help keep you alert for new methods that were added and not documented.\nAlso supports to build a reusable docstring template. Just answer the prompt questions in your terminal to see the effect on your files.\n\n* Keep your Docstrings consistent.\n* Document your DIFF patch.\n* Ease of helping other developers understand your code.\n\n\nAll contributions are welcome. Please follow [Development](#development) steps to get up and running, all PRs are welcome.\nPlease join our [IRC discord channel](https://discord.gg/NWUQtRx) if interested.\n\n## Tech\n\n* [Python 2.7](https://www.python.org/download/releases/2.7/)\n* [Python 3](https://www.python.org/downloads/release/python-373/)\n\n\n## Installation\n\n```\n$ pip install document-your-code\n```\n\n## Usage\n\nThis is intended to work on all programming languages. Kicking off with Python as a starter (Only default formatting added). You can override\nthe default settings for python files and extend new formats in `dyc.yaml` at your root project. Refer to [Example](#example) and [Advanced](#advanced)\n\n\nTo run on all files in a project. Run\n\n```sh\n$ dyc start\n```\n\nTo run on a Git Diff patch. Run\n\n```sh\n$ dyc diff\n```\n\n\nTo have Docstrings prepended on a method while development.\nRun the following command\n```sh\n$ dyc diff --watch\n```\n\n## Method Docstring Options\n\n*You can also Setup your own customized Docstring Method Formatting in `dyc.yaml` within `formats` key*\n\n\n*Methods*\n\n| Key | Description | Type |\n|:-----------------------: |:-----------------------------------------------------------------------------------------------------------------------: |------|\n| `ignore` | Known method Names to be ignored from Docstrings | list |\n| `keywords` | The necessary keyword to search for in a line the triggers actions | list |\n| `enabled` | Determine if formatting is enabled for the extension | bool |\n| `indent` | Indentation in a method. Limited options ['tab', '2 spaces', '4 spaces'] | str |\n| `indent_content` | Confirm if the content of a docstring has to be indented as well | bool |\n| `open` | Starting opener text of a method | str |\n| `close` | Close text of a method. This could be the same as opened, but not all languages opening and closing docstrings are same | str |\n| `break_after_open` | Do we add a new line after adding the open strings of a method? | bool |\n| `break_after_docstring` | Do we add a new line after adding the docstring? | bool |\n| `break_before_close` | Add a new line before closing docstrings on a method | bool |\n| `words_per_line` | How many words do we add per docstring? | int |\n| `within_scope` | Should the docstring be within the scope of the method or out? Just like JS Method docstrings | bool |\n\n\n*Arguments*\n\n| Key | Description | Type |\n|:-----------: |:---------------------------------------------: |:----: |\n| `title` | A title for arguments. i.e: \"Parameters\" | str |\n| `underline` | Underline the title | bool |\n| `add_type` | If true, it will prompt for the argument type | bool |\n| `inline` | Add docstrings all inline or break within. | bool |\n| `ignore` | Arguments to ignore. | list |\n| `prefix` | A prefix like \"@param\". | str |\n\n## Classes Docstring Options\n\n// TODO\n\n## Top of file Options\n\n// TODO\n\n### Example\n\n```sh\n$ cd myapp/\n$ touch example.py\n```\n\n```python\n# example.py\n\ndef hello(name):\n return \"Hello \" + name\n```\n\n```sh\n$ dyc start\n\nProcessing Methods\n\nDo you want to document method hello? [y/N]: y\n\n(hello) Method docstring : DYC Greets you\n\n(name) Argument docstring : John Smith\n(name) Argument type : str\n```\n\n```vim\n## CONFIRM: MODIFY DOCSTRING BETWEEN START AND END LINES ONLY\n\ndef hello(name):\n ## START\n \"\"\"\n DYC Greets you\n Parameters\n ----------\n str name: John Smith\n \"\"\"\n ## END\n return \"Hello \" + name\n~\n~\n~\n```\n\n```sh\n$ cat example.py\n\ndef hello(name):\n \"\"\"\n DYC Greets you\n Parameters\n ----------\n str name: John Smith\n \"\"\"\n return \"Hello \" + name%\n```\n\n*Watch* diff flag.\n\nRun in a terminal session where you have project initialized with Git and on unstaged file. _This will not work (YET) on untracked files_\n```sh\n$ dyc diff --watch\n```\n\nThen on a separate session\n```sh\nvim path/to/file\n```\n\n```sh\n## Append or add\n\ndef auto_document(foo=False):\n return foo\n```\n\nPrint output\n```sh\n$ git diff path/to/file\n\n+\n+def auto_document(foo=False):\n+ \"\"\"\n+ \n+ Parameters\n+ ----------\n+ foo: \n+ \"\"\"\n+ return foo\n```\n\n\n\n\n## Advanced\n\n```sh\n$ cd myapp/\n$ touch example.py\n$ touch dyc.yaml\n```\n\n```python\n# example.py\n\ndef hello(name):\n return \"Hello \" + name\n```\n\n```yml\n# dyc.yaml\n\nformats:\n -\n extension: 'py'\n method:\n indent: 'tab'\n open: \"'''\"\n close: \"'''\"\n break_after_open: false\n break_before_close: false\n arguments:\n title: 'My Customized Title'\n underline: true\n add_type: false\n prefix: '@myAppParam'\n```\n\n```sh\n$ dyc start\n\nProcessing Methods\n\nDo you want to document method hello? [y/N]: y\n\n(hello) Method docstring : Greeting Function\n\n(name) Argument docstring : Human Name\n```\n\n```vim\n## CONFIRM: MODIFY DOCSTRING BETWEEN START AND END LINES ONLY\n\ndef hello(name):\n ## START\n '''Greeting Function\n My Customized Title\n -------------------\n @myAppParam name: Human Name'''\n ## END\n return \"Hello \" + name\n~\n\n```\n\n\n## Development\n\nThank you for taking the time to contribute into this project. It is simple but could be really helpful moving forward to all developers.\n\nTo get started.\n\n1. Fork this repo.\n2. Clone the project.\n3. Setup virtualenv\n3. In the app folder. Run\n\n```sh\n$ pip install --editable .\n```\n\n## With docker\n\n1. docker-compose build\n2. docker-compose run --rm app\n* Do not need ```pip install --editable .```\n\nWe use [black](https://github.com/python/black) to maintain a standard format for our code. Contributions must be black formatted to pass CI.\n\n## License\n\nMIT \u00a9", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Zarad1993/dyc", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "document-your-code", "package_url": "https://pypi.org/project/document-your-code/", "platform": "", "project_url": "https://pypi.org/project/document-your-code/", "project_urls": { "Homepage": "https://github.com/Zarad1993/dyc" }, "release_url": "https://pypi.org/project/document-your-code/0.1.9/", "requires_dist": null, "requires_python": "", "summary": "", "version": "0.1.9" }, "last_serial": 5944146, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "5a72fd5f3bdbe2c68701d54749f2cf09", "sha256": "a2237edce94a0c5874dfffbde44933b64a3c7ec0a420f38aa1254514d2308741" }, "downloads": -1, "filename": "Document Your Code-0.0.1.tar.gz", "has_sig": false, "md5_digest": "5a72fd5f3bdbe2c68701d54749f2cf09", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1033, "upload_time": "2019-03-27T15:40:50", "url": "https://files.pythonhosted.org/packages/e4/cc/c5f87030c5fce181956ebb9e29f19b3d5f97d90b6bb480f5b556c6e6e355/Document%20Your%20Code-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "56b938ca61c795ab7519a6fcc54e62fe", "sha256": "8142f179a45d96fa660d917a4b553bba02a247fc4ad184a967b21d6dcc5fc5c3" }, "downloads": -1, "filename": "Document Your Code-0.0.2.tar.gz", "has_sig": false, "md5_digest": "56b938ca61c795ab7519a6fcc54e62fe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8355, "upload_time": "2019-03-27T20:34:47", "url": "https://files.pythonhosted.org/packages/46/60/74ad9f6ee6608398e4ef47fe5e15a3716071472e047fe5ef826b50426973/Document%20Your%20Code-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "5efb78ff798ba855301cb962cfbe82dc", "sha256": "641f2cf5c4e9c6fb40e9c2b1be136510b91da76c611062397b1cff1960ea6a8e" }, "downloads": -1, "filename": "Document Your Code-0.0.3.tar.gz", "has_sig": false, "md5_digest": "5efb78ff798ba855301cb962cfbe82dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10590, "upload_time": "2019-03-30T20:34:15", "url": "https://files.pythonhosted.org/packages/cf/79/628eb263930aecf5ca64c8e29801b35dae1fd424e909306973a12989b5bd/Document%20Your%20Code-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "75be023261a2d5bab914be75b16997ce", "sha256": "c15257a64869ae31f233404e13a753e583a9e7f8165766655643640aa0578495" }, "downloads": -1, "filename": "document-your-code-0.0.4.tar.gz", "has_sig": false, "md5_digest": "75be023261a2d5bab914be75b16997ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10637, "upload_time": "2019-04-01T19:44:48", "url": "https://files.pythonhosted.org/packages/ad/48/195734f4dd6f4d1a733c73d5fe6a47ead59b59f5626db637c9019d1136d9/document-your-code-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "6fd992e4d5bbf335dae3aaa48cc58288", "sha256": "20abb21249e7e071a55da92203430e0609ec28e35f8b9d27188c009dcc3081cd" }, "downloads": -1, "filename": "document-your-code-0.0.5.tar.gz", "has_sig": false, "md5_digest": "6fd992e4d5bbf335dae3aaa48cc58288", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10893, "upload_time": "2019-04-01T20:52:37", "url": "https://files.pythonhosted.org/packages/c9/79/61ad121cce52ddbe53bb8d01b288ee3c955750bda8f639eef687c3d46528/document-your-code-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "1d7a92f221c8f5b20c97ff0e38e9e6e5", "sha256": "5ecdf4225bfa1787e9e496a4c6f55e953c2781a2769acf49eeef5c671797e1c4" }, "downloads": -1, "filename": "document-your-code-0.0.6.tar.gz", "has_sig": false, "md5_digest": "1d7a92f221c8f5b20c97ff0e38e9e6e5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12798, "upload_time": "2019-04-03T22:50:01", "url": "https://files.pythonhosted.org/packages/a7/e8/bfbdad721591496306e4faa4af68a9de05a071c20d3fa7aa406ec23be455/document-your-code-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "c3821af7fae0686836a382fb70c666db", "sha256": "af8a0d23e8af6a76da5ec5a09afeb12d200b8365dd496c74b81ed5db22286fbe" }, "downloads": -1, "filename": "document-your-code-0.0.7.tar.gz", "has_sig": false, "md5_digest": "c3821af7fae0686836a382fb70c666db", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12762, "upload_time": "2019-04-03T22:50:02", "url": "https://files.pythonhosted.org/packages/70/a3/afb10e50378b957dcf25f780b7bc267083b54157cf2225af61ef13b360f9/document-your-code-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "9da5fbded9dcab8f0f29cdf3a8bdab86", "sha256": "73dc4ec959160c2c405744fb5c828d553280ad609a07bdac080714bb8a91d75a" }, "downloads": -1, "filename": "document-your-code-0.0.8.tar.gz", "has_sig": false, "md5_digest": "9da5fbded9dcab8f0f29cdf3a8bdab86", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12925, "upload_time": "2019-04-04T20:15:47", "url": "https://files.pythonhosted.org/packages/cb/0c/028d5607be75863bd8ec87b6875722e08bc67d49eb1b7ae4cfc3dec01c3d/document-your-code-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "b1c63dc1ad837dca99b2a48c0cc8679c", "sha256": "47e702687e2efb08427d106eeae1e751b33ac19b31cb5d84c6a3633518ccd435" }, "downloads": -1, "filename": "document-your-code-0.0.9.tar.gz", "has_sig": false, "md5_digest": "b1c63dc1ad837dca99b2a48c0cc8679c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12993, "upload_time": "2019-04-07T15:33:48", "url": "https://files.pythonhosted.org/packages/d5/5f/8e9a77faefe2597aec3e45c4b1e5826c8536abe185cdab929348f45f5245/document-your-code-0.0.9.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "066a1f08fedfe3fa79381a34d538e33e", "sha256": "0c82e11974d5b15374b9e3244974a65fd12a60a43badc7fe5bc2d0aa27d01217" }, "downloads": -1, "filename": "document-your-code-0.1.0.tar.gz", "has_sig": false, "md5_digest": "066a1f08fedfe3fa79381a34d538e33e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14021, "upload_time": "2019-04-07T20:42:11", "url": "https://files.pythonhosted.org/packages/97/d6/63f7fcd037534e91267949588d8925e8d32332d9f389cb6418fe83c5fd14/document-your-code-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "e7f3f65e4d9e9a17f690edcf52d9f0af", "sha256": "043d05e4dfde02c5516fc53576fb8295736983b68144086f5aa0f526ee9a2365" }, "downloads": -1, "filename": "document-your-code-0.1.1.tar.gz", "has_sig": false, "md5_digest": "e7f3f65e4d9e9a17f690edcf52d9f0af", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14277, "upload_time": "2019-04-13T07:21:51", "url": "https://files.pythonhosted.org/packages/2e/10/120da2da558a2d59ee145f2f407b16d795343d6ec1ea43a66786f04b0e08/document-your-code-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "269f916c7388debaed4f0fee57ddb1c3", "sha256": "26bd1930578e72b66b5ad3f464b7f97352502e8311d85b710ede04574a0918ff" }, "downloads": -1, "filename": "document-your-code-0.1.2.tar.gz", "has_sig": false, "md5_digest": "269f916c7388debaed4f0fee57ddb1c3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14333, "upload_time": "2019-04-13T08:00:16", "url": "https://files.pythonhosted.org/packages/88/ea/9d555227b6efa64dbbf83e1d12284866091b6ddc35abb543b68f265b1da6/document-your-code-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "171588faef634c45fc169e062a0cd40d", "sha256": "3b39fbf63925bfb0752d0be297095d5f9c3594b3a4305398296bcacc4179a26f" }, "downloads": -1, "filename": "document-your-code-0.1.3.tar.gz", "has_sig": false, "md5_digest": "171588faef634c45fc169e062a0cd40d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14330, "upload_time": "2019-04-13T08:09:45", "url": "https://files.pythonhosted.org/packages/0d/56/2baf7429e00c71d49e85e1248eada767fa13bb6ea2a74caecba168d9c770/document-your-code-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "e6d2dd131291dd99454285777f4daa1d", "sha256": "e38bd4ad79053df158a72af77f22d482c3924220eeffece344cfaee12c593f26" }, "downloads": -1, "filename": "document-your-code-0.1.4.tar.gz", "has_sig": false, "md5_digest": "e6d2dd131291dd99454285777f4daa1d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14405, "upload_time": "2019-05-02T12:12:56", "url": "https://files.pythonhosted.org/packages/f6/6c/26bc882c858f483d39457ee78e0e6bce701d15723ea9004b3d763eff7ec2/document-your-code-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "839b895b992dd4851178648ddbf2e9cd", "sha256": "1200eede9433be87a2f09154bc6d288141316c126982ac1bd80aa79f58b8341f" }, "downloads": -1, "filename": "document-your-code-0.1.5.tar.gz", "has_sig": false, "md5_digest": "839b895b992dd4851178648ddbf2e9cd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14382, "upload_time": "2019-05-05T07:13:04", "url": "https://files.pythonhosted.org/packages/fc/4e/a922088e59bf7cd1b97f6ee45f927771ffe28690ab6bb6f0671d584af2c1/document-your-code-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "f210efb76f765a0d0925759df7e0a5ce", "sha256": "281994f318e6fc131c799417841637eba790e1d491577a42738d7003d098639f" }, "downloads": -1, "filename": "document-your-code-0.1.6.tar.gz", "has_sig": false, "md5_digest": "f210efb76f765a0d0925759df7e0a5ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14668, "upload_time": "2019-05-09T18:59:45", "url": "https://files.pythonhosted.org/packages/a3/fa/95869d5ad8db33b4f702491337dfdf2a4a5ca73bb0499c3a259114940f7e/document-your-code-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "40de2475265b056c062c06c19d0b9830", "sha256": "a54f4918e04147b479be6f5203604658664cf68525c0ef610517ce87bf2eafe9" }, "downloads": -1, "filename": "document-your-code-0.1.7.tar.gz", "has_sig": false, "md5_digest": "40de2475265b056c062c06c19d0b9830", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14924, "upload_time": "2019-06-15T19:20:10", "url": "https://files.pythonhosted.org/packages/4a/db/88ca640cf5d1ff35356bda5ad437d1a84d189c3ad84088740f0477542a2b/document-your-code-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "e480333d59014642532313f4706e0c94", "sha256": "79a49a7c1f1be42f634bcd21424d979d7e7f98a4cb5e9c43a527f32e086aa478" }, "downloads": -1, "filename": "document-your-code-0.1.8.tar.gz", "has_sig": false, "md5_digest": "e480333d59014642532313f4706e0c94", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15515, "upload_time": "2019-10-08T10:16:29", "url": "https://files.pythonhosted.org/packages/05/bb/55fb04ceaff16642616a3683580dc0def35fa030978f394ec3d3c0642bd5/document-your-code-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "a0dd8b7ee837afdb5bed5e1f9147c14f", "sha256": "861c4a66b35138171f1fde2ad36684d174fea424bef042ff12eb5c43af862d25" }, "downloads": -1, "filename": "document-your-code-0.1.9.tar.gz", "has_sig": false, "md5_digest": "a0dd8b7ee837afdb5bed5e1f9147c14f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15147, "upload_time": "2019-10-08T10:24:41", "url": "https://files.pythonhosted.org/packages/9a/0f/a69867b9e20b9a5891895f05912d0caffd149f77f4541ed26825c2f82967/document-your-code-0.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a0dd8b7ee837afdb5bed5e1f9147c14f", "sha256": "861c4a66b35138171f1fde2ad36684d174fea424bef042ff12eb5c43af862d25" }, "downloads": -1, "filename": "document-your-code-0.1.9.tar.gz", "has_sig": false, "md5_digest": "a0dd8b7ee837afdb5bed5e1f9147c14f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15147, "upload_time": "2019-10-08T10:24:41", "url": "https://files.pythonhosted.org/packages/9a/0f/a69867b9e20b9a5891895f05912d0caffd149f77f4541ed26825c2f82967/document-your-code-0.1.9.tar.gz" } ] }