{ "info": { "author": "Christopher Welborn", "author_email": "cj@welbornprod.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX :: Linux", "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Topic :: Software Development :: Libraries", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "FindFunc\n========\n\nFinds and prints function definitions/signatures in source code files.\nIt currently handles JavaScript, Shell, Python (classes too, since\nthey're just functions anyway :smile:), and C-style function\ndefinitions, as well as Makefile targets. It will highlight the body of\nthe functions for readability.\n\nDependencies\n------------\n\nThese are installable with ``pip``:\n\n+--------------------------------------------------------------+------------------------------------------+\n| Name | Description |\n+==============================================================+==========================================+\n| `colr `__ | Terminal colors. |\n+--------------------------------------------------------------+------------------------------------------+\n| `docopt `__ | Command line argument parsing. |\n+--------------------------------------------------------------+------------------------------------------+\n| `printdebug `__ | Debug printing for command line tools. |\n+--------------------------------------------------------------+------------------------------------------+\n| `pygments `__ | Source code highlighting. |\n+--------------------------------------------------------------+------------------------------------------+\n\nInstallation:\n-------------\n\nThis package is listed on PyPi, and is installable with ``pip``:\n\n.. code:: bash\n\n pip install findfunc\n\nUsage\n-----\n\n::\n\n Usage:\n findfunc -h | -v\n findfunc PAT -p [-a] [--color] [-D] [-S] [-s]\n [-c pat] [-C pat] [-e pat] [-f pat] [-l num] [-m num]\n findfunc PAT [PATH...] [-a] [--color] [-D] [-S] [-s]\n [-c pat] [-C pat] [-e pat] [-f pat] [-l num] [-m num]\n\n Options:\n PATH : Zero or more file paths to search.\n If the path is a directory it will be walked.\n Default: stdin\n PAT : Function name or regex pattern to search for.\n -a,--any : Matches anywhere in the name.\n This is the same as: (.+?pattern|pattern.+?)\n --color : Always use color.\n -c pat,--contains pat : Only show definitions that contain this\n pattern in the body.\n -C pat,--without pat : Only show definitions that do not contain\n this pattern in the body.\n This cancels out any -c pattern.\n -D,--debug : Print some debugging info while running.\n -e pat,--exclude pat : Regex pattern to exclude file paths.\n -f pat,--filter pat : Regex pattern to include file paths.\n -h,--help : Show this help message.\n -l num,--length num : Show definitions that match this line length.\n Tests can be prepended:\n >N : More than N lines.\n =N : More than or equal to N lines.\n <=N : Less than or equal to N lines.\n =N : Exactly N lines.\n ==N : Exactly N lines.\n N : Exactly N lines.\n -m num,--maxcount num : Maximum number of definitions to show.\n -p,--paths : Search all directories found in the config\n file.\n -S,--signature : Just print the signatures found.\n -s,--short : Use shorter output mode.\n -v,--version : Show version.\n\n Any file with a name like '[Mm]akefile' will trigger makefile-mode.\n Unfortunately that mode doesn't work for stdin data.\n\n JSON config can be loaded from: ~/findfunc.json\n\nDemo\n----\n\nHere is a recording showing FindFunc's output when ran multiple times\nfor various file types:\n\n|asciicast|\n\nInstead of typing each command, I made a script to do it for me. So it\nmay seem a little fast. It's running ``findfunc PATTERN DIR_OR_FILE``\nwith or without a ``--maxcount`` or ``--signature`` flag set.\n\nConfig\n------\n\nConfig is a JSON file that can be loaded from ``CWD``,\n``~/findfunc.json``, or ``~/.local/share/findfunc.json``.\n\nIt's format is:\n\n.. code:: json\n\n {\n \"default_paths\": [\"my_dir1\", \"my_file1\", \"/home/me/scripts\"]\n }\n\n``default_paths`` is a list of directory or file paths to search when\nthe ``-p`` flag is given.\n\n.. |asciicast| image:: https://asciinema.org/a/112297.png\n :target: https://asciinema.org/a/112297\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/welbornprod/findfunc", "keywords": "python 3 command line tool function class definition signature", "license": "", "maintainer": "", "maintainer_email": "", "name": "FindFunc", "package_url": "https://pypi.org/project/FindFunc/", "platform": "", "project_url": "https://pypi.org/project/FindFunc/", "project_urls": { "Homepage": "https://github.com/welbornprod/findfunc" }, "release_url": "https://pypi.org/project/FindFunc/0.4.4/", "requires_dist": null, "requires_python": "", "summary": "Finds function definitions/signatures from the command line.\n", "version": "0.4.4" }, "last_serial": 5081408, "releases": { "0.4.3": [ { "comment_text": "", "digests": { "md5": "3f50b1d1762e1b05dfb2f2bfad196ce9", "sha256": "df4bd1152da7e400054c558968b5b6ce7101aff0a5e1e744140ed01e4586dc18" }, "downloads": -1, "filename": "FindFunc-0.4.3.tar.gz", "has_sig": false, "md5_digest": "3f50b1d1762e1b05dfb2f2bfad196ce9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11123, "upload_time": "2017-04-10T03:31:36", "url": "https://files.pythonhosted.org/packages/69/a0/3eeb87561ee3f04cd8a1d124e87cbcb43b3110a98fa9ef66e204066ab59f/FindFunc-0.4.3.tar.gz" } ], "0.4.4": [ { "comment_text": "", "digests": { "md5": "685def73f92f8a37319dffeb9bdb2638", "sha256": "462e41b4940565bfba53276617d0cbd6243a1549b8cf6c276dd21e00f46a049b" }, "downloads": -1, "filename": "FindFunc-0.4.4.tar.gz", "has_sig": false, "md5_digest": "685def73f92f8a37319dffeb9bdb2638", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13074, "upload_time": "2019-04-02T23:13:45", "url": "https://files.pythonhosted.org/packages/41/f7/a72755c5ece9514529df90bb0038d772d6625968983a4fed699d86b467d3/FindFunc-0.4.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "685def73f92f8a37319dffeb9bdb2638", "sha256": "462e41b4940565bfba53276617d0cbd6243a1549b8cf6c276dd21e00f46a049b" }, "downloads": -1, "filename": "FindFunc-0.4.4.tar.gz", "has_sig": false, "md5_digest": "685def73f92f8a37319dffeb9bdb2638", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13074, "upload_time": "2019-04-02T23:13:45", "url": "https://files.pythonhosted.org/packages/41/f7/a72755c5ece9514529df90bb0038d772d6625968983a4fed699d86b467d3/FindFunc-0.4.4.tar.gz" } ] }