mMecoPackage - Commands
mmecopackage-create
Command creates a brand new Meco™ package in the active development environment.
Note: You must be in a development environment for this command to work.
Flags
| Short | Long | Type | Default | Example | Description |
|---|---|---|---|---|---|
| name | name | str | N/A | mTestPackage | Name of the package that will be created. |
| e | external | bool | false | N/A | Whether this package is external. |
Examples
mmecopackage-create mTestPackage
# Result
Package has been created: /<PATH>/meco/master/developers/soner/development/main/mTestPackage
mmecopackage-create-python-module
Command creates Python modules for current Meco™ package in the active development environment.
Please note, an unit test module will also be created under test folder for the created Python module.
Note: You must be in a development environment for this command to work.
Flags
| Short | Long | Type | Default | Example | Description |
|---|---|---|---|---|---|
| name | name | str | N/A | utility | Name of the Python module that will be created. |
Examples
cd mCore;
mmecopackage-create-python-module utility
# Result
Created Python modules (Existing modules are untouched):
/<PATH>/meco/master/developers/soner/development/main/mCore/python/mCore/utility.py
/<PATH>/meco/master/developers/soner/development/main/mCore/python/mCore/tests/utilityTest.py
Done.
If you have more than one Python package in your Meco™ package you will be prompted with a question asking which Python package do you want to create the Python module for.
cd mMayaCore;
mmecopackage-create-python-module utility
Available Python Packages for "mMayaCore" package:
1 - mMayaCore
2 - mMayaGUI
3 - mMayaNode
Select a Python Package by entering integer value:
# Enter the int value to select a Python package, i.e. 3
# Result
Created Python modules (Existing modules are untouched):
/<PATH>/meco/master/developers/soner/development/main/mMayaCore/python/sMayaNode/utility.py
/<PATH>/meco/master/developers/soner/development/main/mMayaCore/python/sMayaNode/tests/utilityTest.py
Done.
mmecopackage-create-python-package
Command creates a Python package for current Meco™ package in the active development environment.
Python package will be created in <PACKAGE_NAME>/python folder.
Note: You must be in a development environment for this command to work.
Flags
| Short | Long | Type | Default | Example | Description |
|---|---|---|---|---|---|
| name | name | str | N/A | mMayaUtilities | Name of the Python package that will be created. |
Examples
cd mMayaCore;
mmecopackage-create-python-package mMayaUtilities
# Result
Python package has been created: /<PATH>/meco/master/developers/soner/development/main/mMayaCore/python/mMayaUtilities
mmecopackage-display-doc
Command displays HTML documentation for the Meco™ package in default web browser. The documentation could be local in the package or an URL. You will be prompted with a question to select the documentation you want to display if Meco™ package has more than one documentation listed in its package info module.
Flags
| Short | Long | Type | Default | Example | Description |
|---|---|---|---|---|---|
| n | name | str | N/A | mMecoDocs | Name of the Meco™ package, which the documentation will be displayed for. |
| a | all | bool | false | N/A | Display all the documentations of the package. |
Examples
mmecopackage-display-doc -n mMecoDocs
# Prompted Question
Available documents for "mMecoDocs" package:
1 - Developer Reference - Online : https://meco.safakoner.com/
2 - Python API Reference - Online : https://meco.api.safakoner.com/
3 - Python API Reference : file:///<PATH>/meco/master/developers/soner/development/main/mMecoDocs/doc/developer/pythonAPIReference/html/index.html
Select a documentation by entering integer value:
# Enter the int value to select a Python package, i.e. 2
# Result
Document with the following URL has been opened: https://meco.api.safakoner.com/
Displaying all the documentation for a package.
mmecopackage-display-doc -n mMecoDocs -a
# Result
Available documents for "mMecoDocs" package:
1 - Developer Reference - Online : https://meco.safakoner.com/
2 - Python API Reference - Online : https://meco.api.safakoner.com/
3 - Python API Reference : file:///<PATH>/meco/master/developers/soner/development/main/mMecoDocs/doc/developer/pythonAPIReference/html/index.html
All documents listed above have been opened.
mmecopackage-display-info
Command displays information about a Meco™ package.
Flags
| Short | Long | Type | Default | Example | Description |
|---|---|---|---|---|---|
| name | name | str | N/A | mCore | Name of the Meco™ package, which the information will be displayed for. |
Examples
cd mCore;
mmecopackage-display-info
# Result
NAME : mCore
VERSION : 1.0.0
DESCRIPTION : Core functionalities used by all packages.
KEYWORDS : core, display, enum, namespace, platform, python, version
PLATFORMS : Linux, Darwin, Windows
DOCUMENTS : N/A
APPLICATIONS : all
PYTHON_VERSIONS : 2, 3
IS_ACTIVE : True
IS_EXTERNAL : False
DEVELOPERS : developer@company.com
DEPENDENT_PACKAGES : mFileSystem
PYTHON_PACKAGES : mCore
IS_VERSIONED : False
PATH : /<PATH>/meco/master/developers/soner/development/main/mCore
Stats
Line of code (python) : 1638
Line of code (cpp) : 0
mmecopackage-display-info -n mFileSystem
# Result
NAME : mFileSystem
VERSION : 1.0.0
DESCRIPTION : Operate on files and directories.
KEYWORDS : file, json, directory, watcher, template
PLATFORMS : Linux, Darwin, Windows
DOCUMENTS : N/A
APPLICATIONS : all
PYTHON_VERSIONS : 2, 3
IS_ACTIVE : True
IS_EXTERNAL : False
DEVELOPERS : safak@safakoner.com
DEPENDENT_PACKAGES : mCore
PYTHON_PACKAGES : mFileSystem
IS_VERSIONED : False
PATH : /<PATH>/meco/master/developers/soner/development/main/mFileSystem
Stats
Line of code (python) : 3167
Line of code (cpp) : 0
mmecopackage-find-python-package
Command finds Python package and displays information about the Meco™ package that contains it.
Flags
| Short | Long | Type | Default | Example | Description |
|---|---|---|---|---|---|
| name | name | str | N/A | mFileSystem | Name of the Python package. |
Examples
mmecopackage-find-python-package mMayaGUI
# Result
Python package "mMayaGUI" is contained by the following Meco package:
NAME : mMayaCore
VERSION : 1.0.0
DESCRIPTION : Maya core functionalities.
KEYWORDS : maya, core, namespace, optionvar, reference, menu, utilities, usersetup
PLATFORMS : Linux, Darwin, Windows
DOCUMENTS : N/A
APPLICATIONS : maya
PYTHON_VERSIONS : 2, 3
IS_ACTIVE : True
IS_EXTERNAL : False
DEVELOPERS : developer@company.com
DEPENDENT_PACKAGES : mApplication, mCore, mDeveloper, mMecoPackage
PYTHON_PACKAGES : mMayaCore, mMayaGUI, mMayaNode
IS_VERSIONED : False
PATH : /<PATH>/meco/master/developers/soner/development/main/mMayaCore
mmecopackage-run-unittest
Command runs unit tests in current Meco™ package.
Flags
| Short | Long | Type | Default | Example | Description |
|---|---|---|---|---|---|
| n | name | str | N/A | mFileSystem | Name of the Python package, which the tests will be run for. |
Examples
cd mFileSystem;
mmecopackage-run-unittest
# Result
mFileSystem.tests.directoryLibTest.DirectoryTest 16 Tests
mFileSystem.tests.fileLibTest.FileTest 14 Tests
mFileSystem.tests.jsonFileLibTest.JSONFileTest 3 Tests
mFileSystem.tests.templateFileLibTest.TemplateFileTest 2 Tests
Success.
mmecopackage-search
Command allows you to search Meco™ packages.
Flags
| Short | Long | Type | Default | Example | Description |
|---|---|---|---|---|---|
| keyword | keyword | str | N/A | package | Keyword, which will be used for searching. |
| d | detail | bool | false | N/A | Whether to display details of the packages. |
Examples
mmecopackage-search package
# Result
mCore 1.0.0 /<PATH>/meco/master/developers/soner/development/main/mCore
mMeco 0.5.0 /<PATH>/meco/master/developers/soner/development/main/mMeco
mMecoPackage 1.0.0 /<PATH>/meco/master/developers/soner/development/main/mMecoPackage
mMecoRelease 1.0.0 /<PATH>/meco/master/developers/soner/development/main/mMecoRelease
mMecoSettings 1.0.0 /<PATH>/meco/master/developers/soner/development/main/mMecoSettings
mTestPackage 1.0.0 /<PATH>/meco/master/developers/soner/development/main/mTestPackage
6 packages found.
mmecopackage-search file -d
# Result
NAME : mFileSystem
VERSION : 1.0.0
DESCRIPTION : Operate on files and directories.
KEYWORDS : file, json, directory, watcher, template
PLATFORMS : Linux, Darwin, Windows
DOCUMENTS : N/A
APPLICATIONS : all
PYTHON_VERSIONS : 2, 3
IS_ACTIVE : True
IS_EXTERNAL : False
DEVELOPERS : developer@company.com
DEPENDENT_PACKAGES : mCore
PYTHON_PACKAGES : mFileSystem
IS_VERSIONED : False
PATH : /<PATH>/meco/master/developers/soner/development/main/mFileSystem
1 packages found.