=========
Joint Box
=========
TBD
-----------
Development
-----------
First of all ensure you have all prerequisites:
1. Python >=3.5
2. Virtual Environment tool (virtualenv)
Then follow procedure described below to prepare environment for development:
1. Checkout git repository: ``git clone https://github.com/JointBox/jointbox.git``. Open terminal and change dir to the project root.
2. Create virtual environment: ``virtualenv virtualenv``. Activate it: ``source ./virtualenv/bin/activate``
3. Install development requirements: ``pip install -r requirements.txt``
4. Configure hooks: ``cd .git/hooks && ln -s ../../development/pre-commit-hook.sh pre-commit && cd ../..``
5. Install application as a package in dev mode: ``cd src && ./setup.py sdist``
6. Validate your setup:
* Check if ``jointbox`` and ``jointboxd`` executables are in the context
* Run ``jointbox -h`` and insure that output doesn't contain exceptions
``````````````````````
Development procedures
``````````````````````
Ensure that all python sources contain license notice:
::
./development/copyright-update
In order to run suplementary services under docker you may use predefined docker-compose config:
::
cd ./development/docker
docker-compose up -d
Joint Box
=========
TBD
-----------
Development
-----------
First of all ensure you have all prerequisites:
1. Python >=3.5
2. Virtual Environment tool (virtualenv)
Then follow procedure described below to prepare environment for development:
1. Checkout git repository: ``git clone https://github.com/JointBox/jointbox.git``. Open terminal and change dir to the project root.
2. Create virtual environment: ``virtualenv virtualenv``. Activate it: ``source ./virtualenv/bin/activate``
3. Install development requirements: ``pip install -r requirements.txt``
4. Configure hooks: ``cd .git/hooks && ln -s ../../development/pre-commit-hook.sh pre-commit && cd ../..``
5. Install application as a package in dev mode: ``cd src && ./setup.py sdist``
6. Validate your setup:
* Check if ``jointbox`` and ``jointboxd`` executables are in the context
* Run ``jointbox -h`` and insure that output doesn't contain exceptions
``````````````````````
Development procedures
``````````````````````
Ensure that all python sources contain license notice:
::
./development/copyright-update
In order to run suplementary services under docker you may use predefined docker-compose config:
::
cd ./development/docker
docker-compose up -d
1 maintainer
Release files for jointbox 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jointbox-0.1.1.tar.gz | 36.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jointbox-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 109.3 kB
Release files / jointbox-0.1.1.tar.gz
| Download URL | jointbox-0.1.1.tar.gz |
|---|---|
| Size | 36.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fb483c62fd998eb15da0a89dc1aff0ebae2ac901069ae529e4f51afcfe19240e
|
|
BLAKE2b-256 checksum How to use checksums |
281fccc793f4b5d71f11330055685acda59a3d4831a764233a7d2d642189c4ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / jointbox-0.1.1-py3-none-any.whl
| Download URL | jointbox-0.1.1-py3-none-any.whl |
|---|---|
| Size | 72.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bf75e1cde888203dec70af6f44e1d4f083f136f1b0e480ff93b5238f8fd07120
|
|
BLAKE2b-256 checksum How to use checksums |
d8bdddc2027cf5a427a59787c211c23d94d3bf81ce1da1c40446207b5ac4e9bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
