wa 0.1.0

Installation

Using pip

pip install wa

Using easy_nstall

easy_install wa

from source code

git clone https://github.com/char16t/wa.git
cd wa
make install

Quick start

wa may be called from console

wa
wa: workflow automation tool

wa takes as command arguments, which are mapped to actions. Describing one command startproject you can call it as follows:

wa startproject

Commands unlimited nesting are supported. You can also describe the commands python startproject, startproject cpp or startproject cpplib. You can call them so:

wa startproject python
wa startproject cpp

The commands are described in the files .wa in YAML format. For the examples above it might look like this:

startproject:
    python:
        - input PROJECTNAME
        - mkdir ${PROJECTNAME}
        - mkdir ${PROJECTNAME}/tests ${PROJECTNAME}/${PROJECTNAME}
        - touch ${PROJECTNAME}/tests/__init__.py
        - touch ${PROJECTNAME}/${PROJECTNAME}/__init__.py
    cpp:
        - input PROJECTNAME
        - mkdir ${PROJECTNAME}
        - mkdir ${PROJECTNAME}/src ${PROJECTNAME}/tests ${PROJECTNAME}/include
        - touch ${PROJECTNAME}/CMakeLists.txt
        - touch ${PROJECTNAME}/src/${PROJECTNAME}.cpp
        - touch ${PROJECTNAME}/include/${PROJECTNAME}.hpp
    cpplib:
        - cp /home/user/mypath/templates/cpplib .

The file .wa can be located in the root of your project and in your home directory. wa will first try to do a search of the requested command in the root of your project, and then, if the command is not found, will return to the file .wa in your home directory and looks for there. That is, by creating the file .wa as in the above example in your home directory, you will be able to perform

$ wa startproject python

You are prompted to enter a value for the variable PROJECTNAME

$ wa startproject python
$ PROJECTNAME=_

Let it be helloworld:

$ wa startproject python
$ PROJECTNAME=helloworld

and deploy the skeleton of a Python project helloworld in any directory. Please note that in the current directory, perhaps it should also create an empty file .wa. It will be a signal to wa that it is the root of the project. Now, if you go in a subdirectory of the current directory and attempt to execute an arbitrary command, the search will be done first in that file that is one level higher in the directory tree.

wa does exactly that: search a file in the current directory first, then in the directory above and so on until the root file system. If the file is .wa was not found, the search will continue in your home directory.

In the file .wa lying at the root of your project you can override any command (for example, python startproject from the listings above). That is, you can redistribute it and .wa-file along with the code of your project and to help other developers, for example, to quickly create the skeleton of the class, formatted according to the standards of the project.

wa also allows you to work with files and directories relative to the root of your project. By specifying a vertical line before the path to the file or directory

newclass:
    - input CLASSNAME
    - cp |.code_templates/class.cpp |src/${CLASSNAME}.cpp
    - cp |.code_templates/header.cpp |include/${CLASSNAME}.hpp

In the execution of the above example copies the file .code_templates/class.cpp and .code_templates/header.hpp with the specified name in the directory src and include, respectively. The main thing here is that you can be in any directory of your project, but a copy will be made relative to the root project, because it is explicitly specified with a vertical bar |.

In the example below, a vertical bar at the beginning of the second there are no arguments

newclass:
    - input CLASSNAME
    - cp |.code_templates/class.cpp ${CLASSNAME}.cpp
    - cp |.code_templates/header.cpp ${CLASSNAME}.hpp

When running this example will copy all the files with the specified names in the current directory. For example, if you are in the directory my_great_cpp_app/legacy, the files will be copied into it, and if you’re in my_great_cpp_app/legacy/tests on it.

A vertical bar at the beginning of the paths to files and folders can be used in any commands.

The available commands (API)

You can use the following commands. For each command an example of using.

create_file_and_directory:
    - set PREFIX mysuperpupuer
    - touch ${PREFIX}_file.txt
    - mkdir ${PREFIX}_dir

startproject:
    - input PROJECTNAME
    - mkdir ${PROJECTNAME}
    - touch ${PROJECTNAME}/README.txt

startproject:
    - input PROJECTNAME
    - mkdir ${PROJECTNAME}
    - cd ${PROJECTNAME}
    - touch README.txt

mkdirs:
    - mkdir one two three/four

touchs:
    - touch one two three/four

clean:
    - rm build
    - rm dist

license:
    - input LICENSE_NAME
    - cp /home/user/templates/${LICENSE_NAME}.template |LICENSE

license:
    - input PROJECT_NAME PROJECT_DESCRIPTION PROJECT_LICENSE
    - cptpl /home/user/templates/cpp_lib |.

[[PROJECT_NAME]]
    __init__.py
    [[PRPJECT_NAME]].py
tests
    __init__.py

# This file is a part of <<<PROJECT_NAME>>>
# Licensed under MIT. See LICENSE file for details
# (c) 2015 <<<AUTHOR_NAME>>> <<<<AUTHOR_EMAIL>>>>

def main():
    pass

if __name__ == "__main__":
    main()

pyscaffold:
    - cptpl /home/user/templates/python |.

$ wa pyscaffold
$ PROJECT_NAME=helloworld
$ PROJECT_AUTHOR=Foo Bar
$ AUTHOR_EMAIL=foo@bar.com

helloworld
    __init__.py
    helloworld.py
tests
    __init__.py

# This file is a part of helloworld
# Licensed under MIT. See LICENSE file for details
# (c) 2015 Foo Bar <foo@bar.com>

def main():
    pass

if __name__ == "__main__":
    main()

license:
    - input PROJECT_NAME PROJECT_DESCRIPTION PROJECT_LICENSE
    - cptpljinja2 /home/user/templates/cpp_lib |.

to_legacy:
    - input CLASS
    - mv |src/${CLASS}.cpp |legacy/src/${CLASS}.cpp
    - mv |include/${CLASS}.hpp |legacy/include/${CLASS}.hpp

copy_large_file:
    - cp /home/12Gb.raw |.
    - echo Ok, copied

test:
    - cd |.
    - exec make test

test:
    - cd |.
    - py runtests.py main

Issues

About any errors, problems, any questions or with any suggestions you can write to v.manenkov (at) gmail.com or create a issue in Github Issues https://github.com/char16t/wa/issues

License

Source code licensed under MIT. Текст лицензии находится в файле LICENSE. The license text is in the LICENSE file.