maya-mock-completion 0.0.1__tar.gz

maya_mock_completion-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Bernat Mas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

maya_mock_completion-0.0.1/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.1
+Name: maya_mock_completion
+Version: 0.0.1
+Summary: A mock version of the Autodesk maya libraries to run code intended for maya using a regular Python from a virtual environment.
+Home-page: https://github.com/mrbmp33/maya_mock_completion
+Author: Bernat Mas Pastor
+Author-email: bmp33@duck.com
+License: MIT
+Platform: UNKNOWN
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+# MAYA MOCK COMPLETION
+
+This project is a custom modification of Maya's *commands/api* stub libraries that allows you to execute python code that uses these libraries from a regular python interpreter, ideally the one from your venv.
+
+Developing code for Maya can be a bit sluggish since it normally takes the following steps:
+
+- Opening Maya (maybe multiple times).
+- Setting up a way to send the code from your IDE to Maya.
+- Setting up the command completion to get Maya's libraries on your IDE.
+- Once code is sent, you need to refresh it to apply the changes unless you want to restart the app.
+
+Also, if you are building your own packages you might have other dependencies that you might not want to install to your *mayapy* interpreter. Because of this you might have a separate virtual environment that contains these, but you cannot use a *mayapy* as a base interpreter for creating venvs.
+
+What this package allows you is to separate your code from Maya to a certain degree. By installing this "mock" completion you can use Maya's libraries using a regular python interpreter.
+
+This is different from using the application in *standalone* mode since you won't be initializing any maya at all.
+
+> **Important:** The code will run since it will find Maya's modules (cmds, pymel, api...), and they won't throw any errors due to Maya not being open. However, **please notice that the objects generated by the api only return proxy objects and commands don't do anything real. They just "*pass*" or return other proxy objects**.
+> 
+
+The utility from this is that you can play with these proxy objects and commands in a way that mimics Maya's behavior. Then, when you want you can execute that same code inside Maya and it should behave the same way but providing a meaningful output.
+
+This can also be useful for quick UI development, making unittests and running them from your IDE of choice or making your code just more abstract overall by removing the necessity to run the code inside Maya.
+
+## How to use
+
+You can do one of the following:
+- Install this package via pip once it is available on pypi and just import the modules on your code as normal.
+- Save this package in your directory of choice and add the path to it to your interpreter's list of paths manually.
+
+Then you should be able to run the code using the normal python interpreter.
+
+```python
+# Imports won't crash
+import maya.cmds as mc
+import maya.api.OpenMaya as om
+
+mc.polyCube()  # Should provide flags suggestions with correct typing inference, but it won't do anything
+
+m_obj = om.MGlobal.getActiveSelectionList()  # Returns proxy object that doesn't do anything either but has the same methods as the real object
+```
+
+# Disclaimers
+
+- PySide2's completion hasn't been added in case you might want to run UI code using the real library. If this is not what you want you can use the same principle to run the code in the same way.
+
+- This project is just a concept of a workflow. It might have its shortcomings, and it hasn't been tested in a real production, so I am not entirely sure how useful or reliable it actually is.
+
+- This is still being updated as not all methods of the API mock completion return proxy objects. That is to say these will get updated as they are required.
+
+Cheers and have fun!
+
+

maya_mock_completion-0.0.1/README.md

@@ -0,0 +1,51 @@
+# MAYA MOCK COMPLETION
+
+This project is a custom modification of Maya's *commands/api* stub libraries that allows you to execute python code that uses these libraries from a regular python interpreter, ideally the one from your venv.
+
+Developing code for Maya can be a bit sluggish since it normally takes the following steps:
+
+- Opening Maya (maybe multiple times).
+- Setting up a way to send the code from your IDE to Maya.
+- Setting up the command completion to get Maya's libraries on your IDE.
+- Once code is sent, you need to refresh it to apply the changes unless you want to restart the app.
+
+Also, if you are building your own packages you might have other dependencies that you might not want to install to your *mayapy* interpreter. Because of this you might have a separate virtual environment that contains these, but you cannot use a *mayapy* as a base interpreter for creating venvs.
+
+What this package allows you is to separate your code from Maya to a certain degree. By installing this "mock" completion you can use Maya's libraries using a regular python interpreter.
+
+This is different from using the application in *standalone* mode since you won't be initializing any maya at all.
+
+> **Important:** The code will run since it will find Maya's modules (cmds, pymel, api...), and they won't throw any errors due to Maya not being open. However, **please notice that the objects generated by the api only return proxy objects and commands don't do anything real. They just "*pass*" or return other proxy objects**.
+> 
+
+The utility from this is that you can play with these proxy objects and commands in a way that mimics Maya's behavior. Then, when you want you can execute that same code inside Maya and it should behave the same way but providing a meaningful output.
+
+This can also be useful for quick UI development, making unittests and running them from your IDE of choice or making your code just more abstract overall by removing the necessity to run the code inside Maya.
+
+## How to use
+
+You can do one of the following:
+- Install this package via pip once it is available on pypi and just import the modules on your code as normal.
+- Save this package in your directory of choice and add the path to it to your interpreter's list of paths manually.
+
+Then you should be able to run the code using the normal python interpreter.
+
+```python
+# Imports won't crash
+import maya.cmds as mc
+import maya.api.OpenMaya as om
+
+mc.polyCube()  # Should provide flags suggestions with correct typing inference, but it won't do anything
+
+m_obj = om.MGlobal.getActiveSelectionList()  # Returns proxy object that doesn't do anything either but has the same methods as the real object
+```
+
+# Disclaimers
+
+- PySide2's completion hasn't been added in case you might want to run UI code using the real library. If this is not what you want you can use the same principle to run the code in the same way.
+
+- This project is just a concept of a workflow. It might have its shortcomings, and it hasn't been tested in a real production, so I am not entirely sure how useful or reliable it actually is.
+
+- This is still being updated as not all methods of the API mock completion return proxy objects. That is to say these will get updated as they are required.
+
+Cheers and have fun!