Getting started

Install the project via:

pip install parcell

Choose a working directory for your projects and cd into it.

Now run

parcell add PROJECTNAME

where PROJECTNAME is the name of the project you want to create. Follow all instructions until the script creates your project. If the command cannot be found try restarting the terminal or use python -m parcell … instead.

Then run

parcell start

to start the web interface. Note that you can avoid retyping your passwords for different servers using the --reuse-pw command line argument in either command (given all the servers accept the same password). Once the web interface is started you can interact with your project. When finished you can stop parcell by typing quit in the terminal or pressing CTRL-C. Typing restart restarts the web interface.

Use

parcell -h

or

parcell COMMAND -h

to get further information about the command line capabilities.

Uninstalling

Since parcell adds local and remote files please run

parcell delete

before uninstalling via pip. This makes sure that all local and remote files are removed and all running tasks are stopped. The command can also be used to remove specific servers. Note that in order to be able to clean files on the server side it must be possible to connect to the server at the time of removal.

Contributing

Pull requests are highly appreciated :) Also, feel free to open issues for any questions or bugs you may encounter.

If you want to work on the code of parcell. Set the project up as follows:

git clone https://github.com/JosuaKrause/parcell.git
cd parcell
git submodule update --init --recursive
pip install -e .

This way you need to call parcell via:

python -m parcell ...