summaryrefslogtreecommitdiff
path: root/python-aio-geojson-flightairmap.spec
blob: 424319181bbeb4acf5120e0a7b9965e6d7fe4a4e (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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
%global _empty_manifest_terminate_build 0
Name:		python-aio-geojson-flightairmap
Version:	0.4.21
Release:	1
Summary:	An async GeoJSON client library for planes using information from a Flight Air Map server.
License:	Apache Software License
URL:		https://github.com/kuchel77/python-aio-geojson-flightairmap
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/ad/0e/c6597ef2fac10b8a1056a5654cff6683027b0f8c7e11d50d3a58b0d7dcec/aio_geojson_flightairmap-0.4.21.tar.gz
BuildArch:	noarch

Requires:	python3-aio-geojson-client
Requires:	python3-aiohttp
Requires:	python3-pytz

%description
# python-aio-geojson-flightairmap

[![Build Status](https://travis-ci.org/kuchel77/python-aio-geojson-flighairmap.svg)](https://travis-ci.org/kuchel77/python-aio-geojson-flightairmap)
[![Coverage Status](https://coveralls.io/repos/github/kuchel77/python-aio-geojson-flightairmap/badge.svg?branch=master)](https://coveralls.io/github/exxamalte/python-aio-geojson-flightairmap?branch=master)
[![PyPi](https://img.shields.io/pypi/v/aio-geojson-flightairmap.svg)](https://pypi.python.org/pypi/aio-geojson-flightairmap)
[![Version](https://img.shields.io/pypi/pyversions/aio-geojson-flightairmap.svg)](https://pypi.python.org/pypi/aio-geojson-flightairmap)

This library provides convenient async access to local [Flight Air Map](https://www.flightairmap.com/) geojson feed.

This is an adaption of the [NSW RFS Incidents feed](https://github.com/exxamalte/python-aio-geojson-nsw-rfs-incidents) by Malte Franken.

## Installation
`pip install aio-geojson-flightairmap`

## Usage
See below for examples of how this library can be used. After instantiating a 
particular class - feed or feed manager - and supply the required parameters, 
you can call `update` to retrieve the feed data. The return value 
will be a tuple of a status code and the actual data in the form of a list of 
feed entries specific to the selected feed.

Status Codes
* _OK_: Update went fine and data was retrieved. The library may still 
  return empty data, for example because no entries fulfilled the filter 
  criteria.
* _OK_NO_DATA_: Update went fine but no data was retrieved, for example 
  because the server indicated that there was not update since the last request.
* _ERROR_: Something went wrong during the update

**Parameters**

| Parameter          | Description                               |
|--------------------|-------------------------------------------|
| `home_coordinates` | Coordinates (tuple of latitude/longitude) |

**Supported Filters**

| Filter     |                     | Description |
|------------|---------------------|-------------|
| Radius     | `filter_radius`     | Radius in kilometers around the home coordinates in which events from feed are included. |

**Example**
```python
import asyncio
from aiohttp import ClientSession
from aio_geojson_flightairmap import FlightAirMapFeed
async def main() -> None:
    async with ClientSession() as websession:    
        # Home Coordinates: Latitude: -33.0, Longitude: 150.0
        # Filter radius: 50 km
        feed = FlightAirMapFeed(websession, 
                (-33.0, 150.0), 
                filter_radius=20000)

        status, entries = await feed.update()
        print(status)
        print(entries)
        for e in entries:
            print(e.publication_date)
            print(e.coordinates)
            print(e.flight_num)
asyncio.get_event_loop().run_until_complete(main())
```

## Feed entry properties
Each feed entry is populated with the following properties:

| Name               | Description                                                                                         | Feed attribute |
|--------------------|-----------------------------------------------------------------------------------------------------|----------------|
| geometry           | All geometry details of this entry.                                                                 | `geometry`     |
| coordinates        | Best coordinates (latitude, longitude) of this entry.                                               | `geometry`     |
| external_id        | The unique public identifier for this incident.                                                     | `guid`         |
| title              | Title of this entry.                                                                                | `title`        |
| attribution        | Attribution of the feed.                                                                            | n/a            |
| distance_to_home   | Distance in km of this entry to the home coordinates.                                               | n/a            |
| publication_date   | The publication date of the incidents.                                                              | `pubDate`      |


## Feed Manager

The Feed Manager helps managing feed updates over time, by notifying the 
consumer of the feed about new feed entries, updates and removed entries 
compared to the last feed update.

* If the current feed update is the first one, then all feed entries will be 
  reported as new. The feed manager will keep track of all feed entries' 
  external IDs that it has successfully processed.
* If the current feed update is not the first one, then the feed manager will 
  produce three sets:
  * Feed entries that were not in the previous feed update but are in the 
    current feed update will be reported as new.
  * Feed entries that were in the previous feed update and are still in the 
    current feed update will be reported as to be updated.
  * Feed entries that were in the previous feed update but are not in the 
    current feed update will be reported to be removed.
* If the current update fails, then all feed entries processed in the previous
  feed update will be reported to be removed.

After a successful update from the feed, the feed manager provides two
different dates:

* `last_update` will be the timestamp of the last update from the feed 
  irrespective of whether it was successful or not.
* `last_update_successful` will be the timestamp of the last successful update 
  from the feed. This date may be useful if the consumer of this library wants 
  to treat intermittent errors from feed updates differently.
* `last_timestamp` (optional, depends on the feed data) will be the latest 
  timestamp extracted from the feed data. 
  This requires that the underlying feed data actually contains a suitable 
  date. This date may be useful if the consumer of this library wants to 
  process feed entries differently if they haven't actually been updated.




%package -n python3-aio-geojson-flightairmap
Summary:	An async GeoJSON client library for planes using information from a Flight Air Map server.
Provides:	python-aio-geojson-flightairmap
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-aio-geojson-flightairmap
# python-aio-geojson-flightairmap

[![Build Status](https://travis-ci.org/kuchel77/python-aio-geojson-flighairmap.svg)](https://travis-ci.org/kuchel77/python-aio-geojson-flightairmap)
[![Coverage Status](https://coveralls.io/repos/github/kuchel77/python-aio-geojson-flightairmap/badge.svg?branch=master)](https://coveralls.io/github/exxamalte/python-aio-geojson-flightairmap?branch=master)
[![PyPi](https://img.shields.io/pypi/v/aio-geojson-flightairmap.svg)](https://pypi.python.org/pypi/aio-geojson-flightairmap)
[![Version](https://img.shields.io/pypi/pyversions/aio-geojson-flightairmap.svg)](https://pypi.python.org/pypi/aio-geojson-flightairmap)

This library provides convenient async access to local [Flight Air Map](https://www.flightairmap.com/) geojson feed.

This is an adaption of the [NSW RFS Incidents feed](https://github.com/exxamalte/python-aio-geojson-nsw-rfs-incidents) by Malte Franken.

## Installation
`pip install aio-geojson-flightairmap`

## Usage
See below for examples of how this library can be used. After instantiating a 
particular class - feed or feed manager - and supply the required parameters, 
you can call `update` to retrieve the feed data. The return value 
will be a tuple of a status code and the actual data in the form of a list of 
feed entries specific to the selected feed.

Status Codes
* _OK_: Update went fine and data was retrieved. The library may still 
  return empty data, for example because no entries fulfilled the filter 
  criteria.
* _OK_NO_DATA_: Update went fine but no data was retrieved, for example 
  because the server indicated that there was not update since the last request.
* _ERROR_: Something went wrong during the update

**Parameters**

| Parameter          | Description                               |
|--------------------|-------------------------------------------|
| `home_coordinates` | Coordinates (tuple of latitude/longitude) |

**Supported Filters**

| Filter     |                     | Description |
|------------|---------------------|-------------|
| Radius     | `filter_radius`     | Radius in kilometers around the home coordinates in which events from feed are included. |

**Example**
```python
import asyncio
from aiohttp import ClientSession
from aio_geojson_flightairmap import FlightAirMapFeed
async def main() -> None:
    async with ClientSession() as websession:    
        # Home Coordinates: Latitude: -33.0, Longitude: 150.0
        # Filter radius: 50 km
        feed = FlightAirMapFeed(websession, 
                (-33.0, 150.0), 
                filter_radius=20000)

        status, entries = await feed.update()
        print(status)
        print(entries)
        for e in entries:
            print(e.publication_date)
            print(e.coordinates)
            print(e.flight_num)
asyncio.get_event_loop().run_until_complete(main())
```

## Feed entry properties
Each feed entry is populated with the following properties:

| Name               | Description                                                                                         | Feed attribute |
|--------------------|-----------------------------------------------------------------------------------------------------|----------------|
| geometry           | All geometry details of this entry.                                                                 | `geometry`     |
| coordinates        | Best coordinates (latitude, longitude) of this entry.                                               | `geometry`     |
| external_id        | The unique public identifier for this incident.                                                     | `guid`         |
| title              | Title of this entry.                                                                                | `title`        |
| attribution        | Attribution of the feed.                                                                            | n/a            |
| distance_to_home   | Distance in km of this entry to the home coordinates.                                               | n/a            |
| publication_date   | The publication date of the incidents.                                                              | `pubDate`      |


## Feed Manager

The Feed Manager helps managing feed updates over time, by notifying the 
consumer of the feed about new feed entries, updates and removed entries 
compared to the last feed update.

* If the current feed update is the first one, then all feed entries will be 
  reported as new. The feed manager will keep track of all feed entries' 
  external IDs that it has successfully processed.
* If the current feed update is not the first one, then the feed manager will 
  produce three sets:
  * Feed entries that were not in the previous feed update but are in the 
    current feed update will be reported as new.
  * Feed entries that were in the previous feed update and are still in the 
    current feed update will be reported as to be updated.
  * Feed entries that were in the previous feed update but are not in the 
    current feed update will be reported to be removed.
* If the current update fails, then all feed entries processed in the previous
  feed update will be reported to be removed.

After a successful update from the feed, the feed manager provides two
different dates:

* `last_update` will be the timestamp of the last update from the feed 
  irrespective of whether it was successful or not.
* `last_update_successful` will be the timestamp of the last successful update 
  from the feed. This date may be useful if the consumer of this library wants 
  to treat intermittent errors from feed updates differently.
* `last_timestamp` (optional, depends on the feed data) will be the latest 
  timestamp extracted from the feed data. 
  This requires that the underlying feed data actually contains a suitable 
  date. This date may be useful if the consumer of this library wants to 
  process feed entries differently if they haven't actually been updated.




%package help
Summary:	Development documents and examples for aio-geojson-flightairmap
Provides:	python3-aio-geojson-flightairmap-doc
%description help
# python-aio-geojson-flightairmap

[![Build Status](https://travis-ci.org/kuchel77/python-aio-geojson-flighairmap.svg)](https://travis-ci.org/kuchel77/python-aio-geojson-flightairmap)
[![Coverage Status](https://coveralls.io/repos/github/kuchel77/python-aio-geojson-flightairmap/badge.svg?branch=master)](https://coveralls.io/github/exxamalte/python-aio-geojson-flightairmap?branch=master)
[![PyPi](https://img.shields.io/pypi/v/aio-geojson-flightairmap.svg)](https://pypi.python.org/pypi/aio-geojson-flightairmap)
[![Version](https://img.shields.io/pypi/pyversions/aio-geojson-flightairmap.svg)](https://pypi.python.org/pypi/aio-geojson-flightairmap)

This library provides convenient async access to local [Flight Air Map](https://www.flightairmap.com/) geojson feed.

This is an adaption of the [NSW RFS Incidents feed](https://github.com/exxamalte/python-aio-geojson-nsw-rfs-incidents) by Malte Franken.

## Installation
`pip install aio-geojson-flightairmap`

## Usage
See below for examples of how this library can be used. After instantiating a 
particular class - feed or feed manager - and supply the required parameters, 
you can call `update` to retrieve the feed data. The return value 
will be a tuple of a status code and the actual data in the form of a list of 
feed entries specific to the selected feed.

Status Codes
* _OK_: Update went fine and data was retrieved. The library may still 
  return empty data, for example because no entries fulfilled the filter 
  criteria.
* _OK_NO_DATA_: Update went fine but no data was retrieved, for example 
  because the server indicated that there was not update since the last request.
* _ERROR_: Something went wrong during the update

**Parameters**

| Parameter          | Description                               |
|--------------------|-------------------------------------------|
| `home_coordinates` | Coordinates (tuple of latitude/longitude) |

**Supported Filters**

| Filter     |                     | Description |
|------------|---------------------|-------------|
| Radius     | `filter_radius`     | Radius in kilometers around the home coordinates in which events from feed are included. |

**Example**
```python
import asyncio
from aiohttp import ClientSession
from aio_geojson_flightairmap import FlightAirMapFeed
async def main() -> None:
    async with ClientSession() as websession:    
        # Home Coordinates: Latitude: -33.0, Longitude: 150.0
        # Filter radius: 50 km
        feed = FlightAirMapFeed(websession, 
                (-33.0, 150.0), 
                filter_radius=20000)

        status, entries = await feed.update()
        print(status)
        print(entries)
        for e in entries:
            print(e.publication_date)
            print(e.coordinates)
            print(e.flight_num)
asyncio.get_event_loop().run_until_complete(main())
```

## Feed entry properties
Each feed entry is populated with the following properties:

| Name               | Description                                                                                         | Feed attribute |
|--------------------|-----------------------------------------------------------------------------------------------------|----------------|
| geometry           | All geometry details of this entry.                                                                 | `geometry`     |
| coordinates        | Best coordinates (latitude, longitude) of this entry.                                               | `geometry`     |
| external_id        | The unique public identifier for this incident.                                                     | `guid`         |
| title              | Title of this entry.                                                                                | `title`        |
| attribution        | Attribution of the feed.                                                                            | n/a            |
| distance_to_home   | Distance in km of this entry to the home coordinates.                                               | n/a            |
| publication_date   | The publication date of the incidents.                                                              | `pubDate`      |


## Feed Manager

The Feed Manager helps managing feed updates over time, by notifying the 
consumer of the feed about new feed entries, updates and removed entries 
compared to the last feed update.

* If the current feed update is the first one, then all feed entries will be 
  reported as new. The feed manager will keep track of all feed entries' 
  external IDs that it has successfully processed.
* If the current feed update is not the first one, then the feed manager will 
  produce three sets:
  * Feed entries that were not in the previous feed update but are in the 
    current feed update will be reported as new.
  * Feed entries that were in the previous feed update and are still in the 
    current feed update will be reported as to be updated.
  * Feed entries that were in the previous feed update but are not in the 
    current feed update will be reported to be removed.
* If the current update fails, then all feed entries processed in the previous
  feed update will be reported to be removed.

After a successful update from the feed, the feed manager provides two
different dates:

* `last_update` will be the timestamp of the last update from the feed 
  irrespective of whether it was successful or not.
* `last_update_successful` will be the timestamp of the last successful update 
  from the feed. This date may be useful if the consumer of this library wants 
  to treat intermittent errors from feed updates differently.
* `last_timestamp` (optional, depends on the feed data) will be the latest 
  timestamp extracted from the feed data. 
  This requires that the underlying feed data actually contains a suitable 
  date. This date may be useful if the consumer of this library wants to 
  process feed entries differently if they haven't actually been updated.




%prep
%autosetup -n aio-geojson-flightairmap-0.4.21

%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-aio-geojson-flightairmap -f filelist.lst
%dir %{python3_sitelib}/*

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

%changelog
* Wed May 17 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.21-1
- Package Spec generated