summaryrefslogtreecommitdiff
path: root/python-ocrd-models.spec
blob: b21715786026fd8c28555729660ef36f6797b01d (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
%global _empty_manifest_terminate_build 0
Name:		python-ocrd-models
Version:	2.50.0
Release:	1
Summary:	OCR-D framework - file format APIs and schemas
License:	Apache License 2.0
URL:		https://github.com/OCR-D/core
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/0f/56/194e1dd1185e0f07507aeb660657e5c25d6375f0e9913b4b62be0a32ec01/ocrd_models-2.50.0.tar.gz
BuildArch:	noarch

Requires:	python3-lxml
Requires:	python3-ocrd-utils

%description
# ocrd_models

> OCR-D framework - file format APIs and schemas

## Adding user methods to the generated OcrdPage API

Let's say you want to add a method `get_FirstTextRegion` on the `pc:Page` element:

1. Create a file `ocrd_models/ocrd_page_user_methods/get_FirstTextRegion.py`

    ```python
    def get_FirstTextRegion(self):
        return self.get_TextRegion[0]
    ```

2. Edit `ocrd_models/ocrd_page_user_methods.py` and append to the `METHOD_SPECS` list:

    ```python
    METHOD_SPECS = (
        # ...
        _add_method(r'^PageType$', 'get_FirstTextRegion')
        # ...
    )
    ```

    If the filename (sans the `.py` extension) does not match the method_name, you
    can provide an additional `file_name` attribute to `_add_method`:

    ```python
    METHOD_SPECS = (
        # ...
        _add_method(r'^PageType$', 'exportChildren', 'exportChildren_PageType')
        # ...
    )
    ```

    Would add the method `exportChildren` from a file `exportChildren_PageType.py`.

    > **Note**: 
    > The method name in the file must match the method name passed to
    > `_add_method`. This is *not* checked automatically, so double-check manually!


3. Regenerate the PAGE API:

    ```sh
    make generate-page
    ```


See also: https://github.com/OCR-D/core


%package -n python3-ocrd-models
Summary:	OCR-D framework - file format APIs and schemas
Provides:	python-ocrd-models
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-ocrd-models
# ocrd_models

> OCR-D framework - file format APIs and schemas

## Adding user methods to the generated OcrdPage API

Let's say you want to add a method `get_FirstTextRegion` on the `pc:Page` element:

1. Create a file `ocrd_models/ocrd_page_user_methods/get_FirstTextRegion.py`

    ```python
    def get_FirstTextRegion(self):
        return self.get_TextRegion[0]
    ```

2. Edit `ocrd_models/ocrd_page_user_methods.py` and append to the `METHOD_SPECS` list:

    ```python
    METHOD_SPECS = (
        # ...
        _add_method(r'^PageType$', 'get_FirstTextRegion')
        # ...
    )
    ```

    If the filename (sans the `.py` extension) does not match the method_name, you
    can provide an additional `file_name` attribute to `_add_method`:

    ```python
    METHOD_SPECS = (
        # ...
        _add_method(r'^PageType$', 'exportChildren', 'exportChildren_PageType')
        # ...
    )
    ```

    Would add the method `exportChildren` from a file `exportChildren_PageType.py`.

    > **Note**: 
    > The method name in the file must match the method name passed to
    > `_add_method`. This is *not* checked automatically, so double-check manually!


3. Regenerate the PAGE API:

    ```sh
    make generate-page
    ```


See also: https://github.com/OCR-D/core


%package help
Summary:	Development documents and examples for ocrd-models
Provides:	python3-ocrd-models-doc
%description help
# ocrd_models

> OCR-D framework - file format APIs and schemas

## Adding user methods to the generated OcrdPage API

Let's say you want to add a method `get_FirstTextRegion` on the `pc:Page` element:

1. Create a file `ocrd_models/ocrd_page_user_methods/get_FirstTextRegion.py`

    ```python
    def get_FirstTextRegion(self):
        return self.get_TextRegion[0]
    ```

2. Edit `ocrd_models/ocrd_page_user_methods.py` and append to the `METHOD_SPECS` list:

    ```python
    METHOD_SPECS = (
        # ...
        _add_method(r'^PageType$', 'get_FirstTextRegion')
        # ...
    )
    ```

    If the filename (sans the `.py` extension) does not match the method_name, you
    can provide an additional `file_name` attribute to `_add_method`:

    ```python
    METHOD_SPECS = (
        # ...
        _add_method(r'^PageType$', 'exportChildren', 'exportChildren_PageType')
        # ...
    )
    ```

    Would add the method `exportChildren` from a file `exportChildren_PageType.py`.

    > **Note**: 
    > The method name in the file must match the method name passed to
    > `_add_method`. This is *not* checked automatically, so double-check manually!


3. Regenerate the PAGE API:

    ```sh
    make generate-page
    ```


See also: https://github.com/OCR-D/core


%prep
%autosetup -n ocrd-models-2.50.0

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-ocrd-models -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 2.50.0-1
- Package Spec generated