Revision a1242be5
Added by koszko over 1 year ago
| README.md | ||
|---|---|---|
| 1 |
# These are the sources of Hydrilla builder, a tool to convert packages into a form serveable by Hydrilla.
|
|
| 1 |
# Hydrilla builder
|
|
| 2 | 2 |
|
| 3 |
TODO... |
|
| 3 |
This is the repository of the builder part of [Hydrilla](https://hydrillabugs.koszko.org/projects/hydrilla/wiki). You can find the repository of its server part [here](https://git.koszko.org/pydrilla/). |
|
| 4 |
|
|
| 5 |
Hydrilla builder is a tool to create Haketilo packages in serveable form. The information below is meant to help hack on the codebase. If you're instead looking for some noob-friendly documentation, see the [user manual](https://hydrillabugs.koszko.org/projects/hydrilla/wiki/User_manual). |
|
| 6 |
|
|
| 7 |
## Dependencies |
|
| 8 |
|
|
| 9 |
### Runtime |
|
| 10 |
|
|
| 11 |
* Python3 (>= 3.7) |
|
| 12 |
* click |
|
| 13 |
* jsonschema (>= 3.0) |
|
| 14 |
* reuse [optional] |
|
| 15 |
|
|
| 16 |
### Build |
|
| 17 |
|
|
| 18 |
* setuptools |
|
| 19 |
* wheel |
|
| 20 |
* setuptools_scm |
|
| 21 |
* babel |
|
| 22 |
|
|
| 23 |
### Test |
|
| 24 |
|
|
| 25 |
* pytest |
|
| 26 |
* reuse |
|
| 27 |
|
|
| 28 |
## Building & testing |
|
| 29 |
|
|
| 30 |
Build and test processed are analogous to those described in the [README of Hydrilla server part](https://git.koszko.org/pydrilla/about). |
|
| 31 |
|
|
| 32 |
## Running |
|
| 33 |
|
|
| 34 |
This package provides a hydrilla-builder command. You can use it to build the supplied example with something along the lines of: |
|
| 4 | 35 |
|
| 5 |
To build the supplied example you can do something along the lines of: |
|
| 6 | 36 |
``` |
| 7 | 37 |
mkdir /tmp/bananowarzez/ |
| 38 |
hydrilla-builder -s src/test/source-package-example/ -d /tmp/bananowarzez/ |
|
| 39 |
# Now, list the serveable package files we just produced. |
|
| 40 |
find /tmp/bananowarzez/ |
|
| 41 |
``` |
|
| 42 |
|
|
| 43 |
You might as well like to run from sources, without installation: |
|
| 44 |
mkdir /tmp/bananowarzez/ |
|
| 45 |
./setup.py compile_catalog # generate the necessary .po files |
|
| 8 | 46 |
PYTHONPATH=src python3 -m hydrilla.builder -s src/test/source-package-example/ \ |
| 9 | 47 |
-d /tmp/bananowarzez/ |
| 10 |
# Now, list the files we just produced |
|
| 11 |
find /tmp/bananowarzez/ |
|
| 12 | 48 |
``` |
| 49 |
|
|
| 50 |
You can also consult the included manpage (`man` tool required): |
|
| 51 |
``` shell |
|
| 52 |
man ./doc/man/man1/hydrilla-builder.1 |
|
| 53 |
``` |
|
| 54 |
|
|
| 55 |
## Copying |
|
| 56 |
|
|
| 57 |
Hydrilla is Copyright (C) 2021-2022 Wojtek Kosior and contributors, entirely available under the GNU Affero General Public License version 3 or later. Some files might also give you broader permissions, see comments inside them. |
|
| 58 |
|
|
| 59 |
*I, Wojtek Kosior, thereby promise not to sue for violation of this project's license. Although I request that you do not make use this code in a proprietary program, I am not going to enforce this in court.* |
|
| 60 |
|
|
| 61 |
## Contributing |
|
| 62 |
|
|
| 63 |
Please visit our Redmine instance at https://hydrillabugs.koszko.org. |
|
| 64 |
|
|
| 65 |
You can also write an email to koszko@koszko.org. |
|
Also available in: Unified diff
update README