Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 2.45 KB

README.rst

File metadata and controls

74 lines (53 loc) · 2.45 KB
Raw

mupub - A publishing tool for the Mutopia Project

Documentation Status

Synopsis

Currently the back-end publication software is a collection of shell scripts and Java; this project aims to update this set of tools into a more cohesive and flexible application with more opportunities for automation.

Installing a release

This is a command line tool that will be distributed using standard python3 mechanisms. The distribution will be in the form of a compressed wheel file with the release version embedded in it. Check the releases from the release link above, download, and install.

For example with the first release, mupub-0.3.0, select the link for download and install with pip. Python3.x must be installed on your system.

$ python3 -m pip install mupub-0.3.0-py2.py3-none-any.whl --user

Make sure you use the --user command to install everything locally. There is help from the command line and documentation with examples in the documentation link above.

Development setup

This project uses typical Python3 tools. A virtual environment is recommended to help manage the installed tools. In Ubuntu Linux,

$ sudo apt-get install virtualenv

At Ubuntu 16.04 onward, a convenient set of wrapper functions and scripts are available,

$ sudo apt install virtualenvwrapper
$ echo "source /usr/share/virtualenvwrapper/virtualenvwrapper.sh" >> ~/.bashrc

The wrapper can be organized as you like, but I prefer to manage a single folder hierarchy like this,

$ export WORKON_HOME=~/.virtualenvs
$ mkdir $WORKON_HOME
$ echo "export WORKON_HOME=$WORKON_HOME" >> ~/.bashrc
$ source ~/.bashrc

To create and populate a virtual environment named mupub for this project,

$ cd <your cloned workspace>
$ mkvirtualenv -a $PWD -r requirements.txt -p python3 mupub

To do development on the project you activate the environment using the workon command and leave it using deactivate,

glenl@lola:mupub$ workon mupub
(mupub) glenl@lola:mupub$
(mupub) glenl@lola:mupub$ make test # for example
(mupub) glenl@lola:mupub$ deactivate
glenl@lola:mupub$

Peruse the Makefile for useful development targets. You may need to use the install target to create the command-line utility to test the application CLI.