blob: 37d18ee11789a4173abfe7576903d63745e210c7 (
about) (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
[//]: # ( SPDX-License-Identifier: CC0-1.0 )
[//]: # ( Hydrilla's README file )
[//]: # ( Copyright (C) 2021 Wojtek Kosior )
[//]: # ( Available under the terms of Creative Commons Zero v1.0 Universal. )
# Hydrilla (Python implementation)
This is the repository of Python incarnation of [Hydrilla](https://hydrillabugs.koszko.org/projects/hydrilla/wiki/Wiki), a repository software to serve [Haketilo](https://hydrillabugs.koszko.org/projects/haketilo/wiki) packages.
## Dependencies
* flask
* pytest (for running tests)
Additionally, Hydrilla requires Python 3.
## Building
We're supplying debian packaging. To generate the necessary `debian.tar.gz` and `orig.tar.gz` files, run:
``` shell
python3 setup.py make_tarballs
```
This will generate appropriate `debian.tar.gz` and `orig.tar.gz` in the parent of the project directory.
*TODO: describe debian procedure...*
We're using setuptools. This means you can also do something like:
``` shell
python3 setup.py install
```
*TODO: describe setuptools considerations and mention avoiding pip...*
## Running
Hydrilla can be run from source, without prior installation, provided that its dependencies are present on the system. For this to work, you should first generate GNU Gettext `.mo` files. This is most easily achieved using our custom `setup.py` command:
``` shell
python3 setup.py msgfmt
```
A simple session can then be started with:
``` shell
python3 setup.py run
```
*TODO...*
## Copying
Hydrilla is 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.
*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.*
## Contributing
Please visit our Redmine instance at https://hydrillabugs.koszko.org.
You can also write an email to koszko@koszko.org.
|
