re-arrange modules, preparing for python-package-index

This commit is contained in:
2014-12-19 00:28:47 +01:00
parent 54ef179788
commit 871600312c
31 changed files with 37 additions and 332 deletions

View File

@@ -0,0 +1,29 @@
Installation and requirements
#############################
How to get the system up and running.
Webservice
==========
The web-service is a simple web app based on the Flask framework, plus a few extensions.
In order to get it up and running.
- Create a virtual environment
- Activate the virtual environment
- Install dependencies with ``pip3 install -r requirements.txt``
- Run the service
To learn about the web-service usage, check out the proper (non existing) section.
Client
======
In order to use the `bam` command in your terminal, you can add this file in any of
your BIN paths and call it `bam`. Don't forget to give it +x permissions. ::
#!/bin/sh
exec python /absolute/path/to/bam/client/cli/bam.py "$@"
As you can see, the file links to your bam.py file, so make sure that one is right!