This is droxits microservice framework repository. It yields a python framework to set up microservices easily.
This file is part of ROXcomposer.
ROXcomposer is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You have received a copy of the GNU General Public License along with this program (plain text GPL, Markdown GPL, plain text LGPL, Markdown LGPL). See also http://www.gnu.org/licenses/.
Dev:
Master:
The Python dependencies are listed in the requirements.txt
and the Node.js dependencies are listed in roxconnector_plugin/package.json
.
Please execute
make install-deps
to install all requirements.
The version is generated via the version.sh
script which is called from the Makefile. The resulting version depends on the current branch:
- on
master
the version number inVERSION
will be used. - on
dev
the version number will beVERSION.devN
whereN
is the number of revisions thatdev
is ahead ofmaster
. - on any other branch it will be
VERSION.devN+<NORMALIZED_BRANCH_NAME>M
.M
is the number of revisions that this branch is ahead of dev. WhileN
is the number of revisions that this branch is ahead ofmaster
minusM
. This is meant to ensure thatN
is the number of revisions thatdev
was ahead of master when this branch was forked. The normalized branch name is the branch name stripped from any non-alphanumeric characters. At the moment effectively only-
and_
are stripped. If you use any additional non-alphanumeric characters in your branch names, please adjust theversion.sh
. Otherwise version inconsitencies will occur and the build process might fail.
In order to run tests, please use
make test
The whole package:
make demo-package
You will be prompted for creadentials for the droxIT artifact repository. Alternatively those can be provided in the ARTIFACT_AUTH
environment variable as a username:password
pair.
the built package will be under build/roxcomposer-demo-<VERSION>
.
Only the python package:
make python-package
The package will be in the dist
folder.
Running
make deploy-demo
will ask you for a directory to deploy to. It will attempt to extract the package at the given location and install the dependencies.
For further documentation please consider reading the handbook.