party 🎉

The python task runner

party is an task runner written in python for python. It automates all the steps which the users need to do, like installing components, updating dependencies or getting the latest source. Also its very extensible and you can create and install plugins. You can view the documentation for more informations.

Installation

You'll need to install

• python3.4.2
• git

first (installer script on Windows supports only Python 3.4.x).

Windows

Download one of the latest releases, and extract the ZIP/TAR package. Fire up an command prompt and run this:

$ cd bin
$ python install-win32

if you receive 'everything fine.', you can be sure that party is installed. You'll need to add the bin directory to your PATH manually!

If you use an older version of Python you can follow the steps for Linux/OSX to manual install party!

Linux/OSX

Currently I am not able to run an Linux or OSX system and this is a manual way to install party (would be nice if anyone could write an installer script)

1. Download the latest source of party
2. Extract it to any location
3. Create an new folder in your Python site packages folder with the name party_plugins
4. Copy all files from the plugins folder into it
5. Add the bin directory to your PATH
6. not required: on some systems you'll need to reboot

Now you can test if party was successfully installed. This can be done by running this in terminal:

$ party -v

If this shows you the version informations, everything works fine.

Sample partyfile.py

An partyfile is recognized by the party CLI tool and contains the tasks you'll want to automate.

This is an simple example which uses the Git plugin:

#!=party

# you can also import everything using 'import *'
from party_plugins import git

# creating tasks need the 'task' before the 'def' keyword
task def example_task():
    client = git.gitClient()

    client.clone_repo('https://github.com/example/example.git')

# now we need to make it available to run the task
def runTasks():
	example_task() # runs the example_task() task

Shipped plugins

These plugins are shipped with party:

• .git: an easy to use git client for your partyfiles
• .brew: an easy to use homebrew client for your partyfiles (OSX only)
• .apt: an easy to use apt-get client for your partyfiles (UNIX only)
• .get: an easy to use download client for your partyfiles

Known Issues

Windows

• starting party from command line doesn't works. msys and git bash recommended

Feel free to report any issue you get here

License

party is published under the terms of the MIT License.