# README - ${project}
Welcome to Canari. You might be wondering what all these files are about. Before you can use the power of
-```mtginstall``` you needed to create a transform package and that's exactly what you did here! I've given you a
+`canari install-package` you needed to create a transform package and that's exactly what you did here! I've given you a
directory structure to use in the following manner:
-* ```src/${package}``` directory is where all your stuff goes in terms of auxiliary modules that you may need for your
+* `src/${package}` directory is where all your stuff goes in terms of auxiliary modules that you may need for your
modules
-* ```src/${package}/transforms``` directory is where all your transform modules should be placed. An example
- ```helloworld``` transform is there for your viewing pleasure.
-* ```src/${package}/transforms/common``` directory is where you can put some common code for your transforms like result
+* `src/${package}/transforms` directory is where all your transform modules should be placed. An example
+ `helloworld` transform is there for your viewing pleasure.
+* `src/${package}/transforms/common` directory is where you can put some common code for your transforms like result
parsing, entities, etc.
-* ```src/${package}/transforms/common/entities.py``` is where you define your custom entities. Take a look at the
+* `src/${package}/transforms/common/entities.py` is where you define your custom entities. Take a look at the
examples provided if you want to play around with custom entities.
-* ```maltego/``` is where you can store your Maltego entity exports.
+* `maltego/` is where you can store your Maltego entity exports.
-If you're going to add a new transform in the transforms directory, remember to update the ```__all__``` variable in
-```src/${package}/transforms/__init__.py```. Otherwise, ```mtginstall``` won't attempt to install the transform.
-Alternatively, ```mtgtransgen <transform name>``` can be used within the ```src/${package}/transforms``` directory to
-generate a transform module and have it automatically added to the ```__init__.py``` file, like so:
+If you're going to add a new transform in the transforms directory, remember to update the `__all__` variable in
+`src/${package}/transforms/__init__.py`. Otherwise, `canari install-package` won't attempt to install the transform.
+Alternatively, `canari create-transform <transform name>` can be used within the `src/${package}/transforms` directory
+to generate a transform module and have it automatically added to the `__init__.py` file, like so:
-To test your transform, simply ```cd``` into the src directory and run ```mtgdebug```, like so:
+To test your transform, simply `cd` into the src directory and run `canari debug-transform`, like so:
```bash
-$$ mtgdebug ${project}.transforms.helloworld Phil
+$$ canari debug-transform ${project}.transforms.helloworld Phil
%50
D:This was pointless!
%100
from canari.framework import configure #, superuser
__author__ = '${author}'
-__copyright__ = 'Copyright ${year}, <project> Project'
+__copyright__ = 'Copyright ${year}, ${project} Project'
__credits__ = []
__license__ = 'GPL'
__version__ = '0.1'
-__maintainer__ = '${author}'
-__email__ = 'whereim@onthe.net'
+__maintainer__ = '${maintainer}'
+__email__ = '${email}'
__status__ = 'Development'
__all__ = [
'onterminate'
]
-# Uncomment the line below if the transform needs to run as super-user
-#@superuser
+
"""
TODO: set the appropriate configuration parameters for your transform.
+TODO: Uncomment the line below if the transform needs to run as super-user
"""
+#@superuser
@configure(
label='TODO: To Something [Hello World]',
description='TODO: Returns a Something entity with the phrase "Hello Word!"',
projects / get-hack-src.git / commitdiff