{ "info": { "author": "Andres Weber", "author_email": "andresmweber@gmail.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: Public Domain", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Utilities" ], "description": "maya-cmds-help: For people who just really want to check their maya.cmds signatures\n###################################################################################################\n`Online Documentation (ReadTheDocs) `_\n\n.. image:: https://badge.fury.io/py/Maya-Signature-Scraper.svg\n :target: https://badge.fury.io/py/Maya-Signature-Scraper\n\n.. image:: https://travis-ci.org/AndresMWeber/mayasig_cli.svg?branch=master\n :target: https://travis-ci.org/AndresMWeber/mayasig_cli\n\n.. image:: https://coveralls.io/repos/github/AndresMWeber/mayasig_cli/badge.svg?branch=master\n :target: https://coveralls.io/github/AndresMWeber/mayasig_cli?branch=master\n\n.. image:: https://landscape.io/github/AndresMWeber/maya-cmds-help/master/landscape.svg?style=flat\n :target: https://landscape.io/github/AndresMWeber/maya-cmds-help/master\n :alt: Code Health\n\n.. contents::\n\n.. section-numbering::\n\nSynopsis\n=============\n\nIf you're looking into this tool, you're looking for a programmatic way of getting Maya function signatures. The current version of the tool has unfiltered prints as status logs...so that might be a deterrent... I personally built it so that I could compare my maya command calls against kwargs/args Maya expects to reduce errors.\n\nHope you'll find it useful! Once you install you will now have a CLI tool called mayasig.\n\nFeatures\n--------\n- Caching\n- Up to date with online help docs\n- Temp file generator\n- JSON file output\n- CLI access\n- Dict output\n\nInstallation\n============\nWindows, etc.\n-------------\nA universal installation method (that works on Windows, Mac OS X, Linux, \u2026, and always provides the latest version) is to use `pip`:\n\n.. code-block:: bash\n\n # Make sure we have an up-to-date version of pip and setuptools:\n $ pip install --upgrade pip setuptools\n $ pip install maya-cmds-help\n\n\n(If ``pip`` installation fails for some reason, you can try\n``easy_install maya-cmds-help`` as a fallback.)\n\nUsage\n=============\n\nBash\n------------\n\n.. code-block:: bash\n\n mayasig\n\n Usage:\n mayasig [-m|--mayaversion VERSION] [-d|--depth DEPTH] (MAYA_CMDS ...)\n mayasig (-h|--help)\n mayasig (--version)\n\n Options:\n -h --help Show this screen.\n --version Show version.\n -m VERSION --mayaversion VERSION If you want to override which Maya docs we query (tested with 2015/2016/2017) [default: 2017]\n -d DEPTH --depth DEPTH The depth verbosity of the return dictionary [default: 1]\n MAYA_CMDS Maya commands to query/scrape from the help and return signatures for\n\n Examples:\n mayasig group\n\n Help:\n For help using this tool, please open an issue on the Github repository:\n https://github.com/andresmweber/mayasig-cli\n\nPython Package Usage\n---------------------\nFeel free to access from the package instead via the two package-level convenience functions:\n\n.. code-block:: python\n\n maya_signatures.CACHE\n maya_signatures.query\n\nIn order to access full functionality from the scraper class you can access a package level instance of maya_signatures.commands.scrape.Scraper using:\n\n.. code-block:: python\n\n maya_signatures.SCRAPER\n\n\n.. code-block:: python\n\n import maya_signatures\n maya_signatures.query('ls')\n # Result:\n # storing args ('ls',) storing kwargs {}\n # Successfully loaded json data, loading into cache...\n # Retrieving cached value for input http://help.autodesk.com/cloudhelp/2017/ENU/Maya-Tech-Docs/CommandsPython/ls.html\n # wrote out tmp file C:\\Users\\andre\\dev\\maya_signature_builder\\scrape.json\n\n maya_signatures.SCRAPER.build_command_stub('ls')\n # Result: def ls(*args, textures=bool, selection=bool, defaultNodes=bool, templated=bool, visible=bool, references=bool, flatten=bool, nodeTypes=bool, persistentNodes=bool, intermediateObjects=bool, long=bool, leaf=bool, recursive=bool, objectsOnly=bool, lockedNodes=bool, cameras=bool, tail=int, absoluteName=bool, lights=bool, live=bool, renderSetups=bool, containerType=str, preSelectHilite=bool, type=str, containers=bool, shortNames=bool, renderResolutions=bool, head=int, showType=bool, dependencyNodes=bool, orderedSelection=bool, renderQualities=bool, readOnly=bool, referencedNodes=bool, showNamespace=bool, invisible=bool, hilite=bool, untemplated=bool, partitions=bool, ghost=bool, uuid=bool, sets=bool, geometry=bool, assemblies=bool, noIntermediate=bool, modified=bool, allPaths=bool, shapes=bool, materials=bool, excludeType=str, planes=bool, exactType=str, renderGlobals=bool, undeletable=bool, dagObjects=bool, transforms=bool):\n # pass\n\n.. code-block:: python\n\n maya_signatures.query('group')\n # Result: storing args ('group',) storing kwargs {}\n # Successfully loaded json data, loading into cache...\n # Could not find key http://help.autodesk.com/cloudhelp/2017/ENU/Maya-Tech-Docs/CommandsPython/group.html in cached values...retrieving...\n # Trying to find command for web page:\n # http://help.autodesk.com/cloudhelp/2017/ENU/Maya-Tech-Docs/CommandsPython/group.html\n # wrote out tmp file C:\\Users\\andre\\dev\\maya_signature_builder\\scrape.json\n maya_signatures.SCRAPER.get_command_flags('group')\n # Result: [('name', 'n'), ('parent', 'p'), ('relative', 'r'), ('useAsGroup', 'uag'), ('world', 'w'), ('empty', 'em'), ('absolute', 'a')]\n\n\nVersion Support\n===============\nThis package supports the Maya 2015, 2016 and 2017 help docs so far so please be aware.\nI might back port a couple versions of the maya online help, but this is totally dependent on time.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/andresmweber/maya-cmds-help.git", "keywords": "cli,maya,stubs,stub,commands,maya.cmds,autodesk", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "maya-cmds-help", "package_url": "https://pypi.org/project/maya-cmds-help/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/maya-cmds-help/", "project_urls": { "Homepage": "https://github.com/andresmweber/maya-cmds-help.git" }, "release_url": "https://pypi.org/project/maya-cmds-help/0.6.4/", "requires_dist": null, "requires_python": "", "summary": "A module and command line tool that scrapes the online maya help docs to query an input maya.cmds command (or build stubs) for its signature in Python.", "version": "0.6.4" }, "last_serial": 2904970, "releases": { "0.5.9": [], "0.6.2": [ { "comment_text": "", "digests": { "md5": "6eb9c7ca3443d43035c0abaa1b217ff4", "sha256": "fa3b1caa470aeb2ef718eabed59c2ac652c9513c6646e9df3cf90cb4e56590be" }, "downloads": -1, "filename": "maya-cmds-help-0.6.2.tar.gz", "has_sig": false, "md5_digest": "6eb9c7ca3443d43035c0abaa1b217ff4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10545, "upload_time": "2017-05-10T21:35:31", "url": "https://files.pythonhosted.org/packages/2a/5f/47b67770a5431318f655349d052597d7b79bd72c3f46435448ffcca4bc26/maya-cmds-help-0.6.2.tar.gz" } ], "0.6.3": [ { "comment_text": "", "digests": { "md5": "7188cfbb5f641382f66bd4547ad21a53", "sha256": "dd68ce5f6459bfe870733193ccbe29debe21f9b8d4f97c30e8c3000caa4948c0" }, "downloads": -1, "filename": "maya-cmds-help-0.6.3.tar.gz", "has_sig": false, "md5_digest": "7188cfbb5f641382f66bd4547ad21a53", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10539, "upload_time": "2017-05-28T18:06:26", "url": "https://files.pythonhosted.org/packages/9f/2d/fd0a828257a11c750b32aaba38923b6b3942e0e2f6c7619924170decfe9f/maya-cmds-help-0.6.3.tar.gz" } ], "0.6.4": [ { "comment_text": "", "digests": { "md5": "1f308ba39445b2800ca610ec0e4be897", "sha256": "044eaa2d989d0774065e08f41374afe372864d51f8ca846ef8a0e0961f90ca4e" }, "downloads": -1, "filename": "maya-cmds-help-0.6.4.tar.gz", "has_sig": false, "md5_digest": "1f308ba39445b2800ca610ec0e4be897", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10543, "upload_time": "2017-05-28T18:27:27", "url": "https://files.pythonhosted.org/packages/47/5b/3f7422b42f2717b5c3584383efe15e2676281a82843f7cb021dff23f5986/maya-cmds-help-0.6.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1f308ba39445b2800ca610ec0e4be897", "sha256": "044eaa2d989d0774065e08f41374afe372864d51f8ca846ef8a0e0961f90ca4e" }, "downloads": -1, "filename": "maya-cmds-help-0.6.4.tar.gz", "has_sig": false, "md5_digest": "1f308ba39445b2800ca610ec0e4be897", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10543, "upload_time": "2017-05-28T18:27:27", "url": "https://files.pythonhosted.org/packages/47/5b/3f7422b42f2717b5c3584383efe15e2676281a82843f7cb021dff23f5986/maya-cmds-help-0.6.4.tar.gz" } ] }