Project

General

Profile

Download (3.62 KB) Statistics
| Branch: | Tag: | Revision:

hydrilla-builder / PKG-INFO @ debian-debian

1 6bc04f80 Wojtek Kosior
Metadata-Version: 2.1
2
Name: hydrilla.builder
3 22c722bf Wojtek Kosior
Version: 1.1b1
4 6bc04f80 Wojtek Kosior
Summary: Hydrilla package builder
5
Home-page: https://git.koszko.org/hydrilla-builder
6
Author: Wojtek Kosior
7
Author-email: koszko@koszko.org
8
License: AGPL-3.0-or-later
9
Project-URL: Bug Tracker, https://hydrillabugs.koszko.org/projects/hydrilla
10
Description: # Hydrilla builder
11
        
12
        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/).
13
        
14
        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).
15
        
16
        ## Dependencies
17
        
18
        ### Runtime
19
        
20
        * Python3 (>= 3.7)
21
        * click
22
        * jsonschema (>= 3.0)
23
        * reuse [optional]
24
        
25
        ### Build
26
        
27 22c722bf Wojtek Kosior
        * build (a PEP517 package builder)
28 6bc04f80 Wojtek Kosior
        * setuptools
29
        * wheel
30
        * setuptools_scm
31 22c722bf Wojtek Kosior
        * babel (Python library)
32 6bc04f80 Wojtek Kosior
        
33
        ### Test
34
        
35
        * pytest
36
        
37 22c722bf Wojtek Kosior
        ## Building & testing & installation from wheel
38 6bc04f80 Wojtek Kosior
        
39 22c722bf Wojtek Kosior
        Build, test and installation processes are analogous to those described in the [README of Hydrilla server part](https://git.koszko.org/pydrilla/about).
40 6bc04f80 Wojtek Kosior
        
41
        ## Running
42
        
43
        This package provides a hydrilla-builder command. You can use it to build the supplied example with something along the lines of:
44
        
45
        ```
46
        mkdir /tmp/bananowarzez/
47
        hydrilla-builder -s src/test/source-package-example/ -d /tmp/bananowarzez/
48
        # Now, list the serveable package files we just produced.
49
        find /tmp/bananowarzez/
50
        ```
51
        
52
        You might as well like to run from sources, without installation:
53 22c722bf Wojtek Kosior
        
54
        ``` shell
55 6bc04f80 Wojtek Kosior
        mkdir /tmp/bananowarzez/
56
        ./setup.py compile_catalog # generate the necessary .po files
57
        PYTHONPATH=src python3 -m hydrilla.builder -s src/test/source-package-example/ \
58
        	       -d /tmp/bananowarzez/
59
        ```
60
        
61
        You can also consult the included manpage (`man` tool required):
62
        ``` shell
63
        man ./doc/man/man1/hydrilla-builder.1
64
        ```
65
        
66
        ## Copying
67
        
68
        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.
69
        
70
        *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.*
71
        
72
        ## Contributing
73
        
74
        Please visit our Redmine instance at https://hydrillabugs.koszko.org.
75
        
76
        You can also write an email to koszko@koszko.org.
77
        
78
Keywords: hydrilla,haketilo
79
Platform: UNKNOWN
80
Classifier: Development Status :: 4 - Beta
81
Classifier: Intended Audience :: Developers
82
Classifier: Environment :: Console
83
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
84
Classifier: Natural Language :: English
85
Classifier: Operating System :: OS Independent
86
Classifier: Programming Language :: Python :: 3 :: Only
87
Classifier: Topic :: Software Development :: Build Tools
88
Requires-Python: >=3.7
89
Description-Content-Type: text/markdown
90
Provides-Extra: setup
91 22c722bf Wojtek Kosior
Provides-Extra: spdx
92 6bc04f80 Wojtek Kosior
Provides-Extra: test