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
|
%global _empty_manifest_terminate_build 0
Name: python-spectre-api
Version: 0.5.4
Release: 1
Summary: Wrapper to use the Lumeta Spectre API
License: MIT
URL: https://pypi.org/project/spectre-api/
Source0: https://mirrors.aliyun.com/pypi/web/packages/2a/84/0a7511b1e76a97c3bb98d59a0760c875260d20defcaaf95b2bc1e7148994/spectre-api-0.5.4.tar.gz
BuildArch: noarch
Requires: python3-requests
%description
# spectre-api-python
## General
This module is intended to make it a bit easier to work with
The Lumeta Corporation's Spectre API.
Lumeta and Spectre are both registered trademarks of the Lumeta Corporation
Install this module by running `pip3 install spectre-api`
### Introduction
This Python module is intended to be a relatively light weight wrapper around the Spectre API.
The idea is to abstract out some of the authentication and paging pieces to make it easier to
focus on fine-tuning the actual underlying calls. Basically, you configure a server
(currently using username/password or API Key authentication) and then have it perform API calls.
For example:
```python
>>> import spectreapi
>>> s = spectreapi.UsernameServer("cc", "username", "password")
>>> r = s.get("zonedata/devices", params = { "filter.zone.id": 1} )
>>> for d in r:
... if d['ip'] is not None:
... print(d['ip'])
...
10.2.1.1
10.201.0.1
10.201.0.7
10.202.0.1
10.202.0.2
172.18.1.180
>>>
```
Another, slightly cleaner way to do this would be to use the query methods
```python
>>> import spectreapi
>>> z = spectreapi.UsernameServer('cc','username','password').get_zone_by_name('Zone1')
>>> q=z.query().detail('Attributes')
>>> for d in q.run():
... if d['ip'] is not None:
... print(d['ip'])
...
10.2.1.1
10.201.0.1
10.201.0.7
10.202.0.1
10.202.0.2
172.18.1.180
>>>
```
## Servers
A **Server** is the base class that has most of the functionality
needed to use the Spectre API. You'll instantiate a more specific
**Server** based on which authentication method you're using.
### UsernameServer
`spectreapi.UsernameServer(<server>, <username>, <password>, [<page_size>,] [<verify>])`
Where:
`<server>` = The IP address or DNS name of the Spectre Command Center
`<username>` = Username
`<password>` = Password
`<page_size>` = How many results should a GET request return at a time.
`<verify>` = Should we verify the SSL certificate of the server (True or False, defaults to False). You'll want to leave this a False unless you've given your command center an actual SSL certificate.
Behind the scenes, this makes an API call to `system/information` with basic authentication
(over https) and then uses the resulting JSESSIONID cookie for the rest of the time.
### APIKeyServer
`spectreapi.APIKeyServer(<server>, <api_key>, [, <page_size>] [, <verify>])`
Where:
`<server>` = The IP address or DNS name of the Spectre Command Center
`<api_key>` = API Key for API access. You get this via the GUI or by issuing the
`user key new <username>` command at the command center CLI.
`<page_size>` = How many results should a GET request return at a time.
`<verify>` = Should we verify the SSL certificate of the server (True or False, defaults to False). You'll want to leave this a False unless you've given your command center an actual SSL certificate.
## GET, POST, PUT, DELETE
## Notes on using the underlying Spectre API
%package -n python3-spectre-api
Summary: Wrapper to use the Lumeta Spectre API
Provides: python-spectre-api
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-spectre-api
# spectre-api-python
## General
This module is intended to make it a bit easier to work with
The Lumeta Corporation's Spectre API.
Lumeta and Spectre are both registered trademarks of the Lumeta Corporation
Install this module by running `pip3 install spectre-api`
### Introduction
This Python module is intended to be a relatively light weight wrapper around the Spectre API.
The idea is to abstract out some of the authentication and paging pieces to make it easier to
focus on fine-tuning the actual underlying calls. Basically, you configure a server
(currently using username/password or API Key authentication) and then have it perform API calls.
For example:
```python
>>> import spectreapi
>>> s = spectreapi.UsernameServer("cc", "username", "password")
>>> r = s.get("zonedata/devices", params = { "filter.zone.id": 1} )
>>> for d in r:
... if d['ip'] is not None:
... print(d['ip'])
...
10.2.1.1
10.201.0.1
10.201.0.7
10.202.0.1
10.202.0.2
172.18.1.180
>>>
```
Another, slightly cleaner way to do this would be to use the query methods
```python
>>> import spectreapi
>>> z = spectreapi.UsernameServer('cc','username','password').get_zone_by_name('Zone1')
>>> q=z.query().detail('Attributes')
>>> for d in q.run():
... if d['ip'] is not None:
... print(d['ip'])
...
10.2.1.1
10.201.0.1
10.201.0.7
10.202.0.1
10.202.0.2
172.18.1.180
>>>
```
## Servers
A **Server** is the base class that has most of the functionality
needed to use the Spectre API. You'll instantiate a more specific
**Server** based on which authentication method you're using.
### UsernameServer
`spectreapi.UsernameServer(<server>, <username>, <password>, [<page_size>,] [<verify>])`
Where:
`<server>` = The IP address or DNS name of the Spectre Command Center
`<username>` = Username
`<password>` = Password
`<page_size>` = How many results should a GET request return at a time.
`<verify>` = Should we verify the SSL certificate of the server (True or False, defaults to False). You'll want to leave this a False unless you've given your command center an actual SSL certificate.
Behind the scenes, this makes an API call to `system/information` with basic authentication
(over https) and then uses the resulting JSESSIONID cookie for the rest of the time.
### APIKeyServer
`spectreapi.APIKeyServer(<server>, <api_key>, [, <page_size>] [, <verify>])`
Where:
`<server>` = The IP address or DNS name of the Spectre Command Center
`<api_key>` = API Key for API access. You get this via the GUI or by issuing the
`user key new <username>` command at the command center CLI.
`<page_size>` = How many results should a GET request return at a time.
`<verify>` = Should we verify the SSL certificate of the server (True or False, defaults to False). You'll want to leave this a False unless you've given your command center an actual SSL certificate.
## GET, POST, PUT, DELETE
## Notes on using the underlying Spectre API
%package help
Summary: Development documents and examples for spectre-api
Provides: python3-spectre-api-doc
%description help
# spectre-api-python
## General
This module is intended to make it a bit easier to work with
The Lumeta Corporation's Spectre API.
Lumeta and Spectre are both registered trademarks of the Lumeta Corporation
Install this module by running `pip3 install spectre-api`
### Introduction
This Python module is intended to be a relatively light weight wrapper around the Spectre API.
The idea is to abstract out some of the authentication and paging pieces to make it easier to
focus on fine-tuning the actual underlying calls. Basically, you configure a server
(currently using username/password or API Key authentication) and then have it perform API calls.
For example:
```python
>>> import spectreapi
>>> s = spectreapi.UsernameServer("cc", "username", "password")
>>> r = s.get("zonedata/devices", params = { "filter.zone.id": 1} )
>>> for d in r:
... if d['ip'] is not None:
... print(d['ip'])
...
10.2.1.1
10.201.0.1
10.201.0.7
10.202.0.1
10.202.0.2
172.18.1.180
>>>
```
Another, slightly cleaner way to do this would be to use the query methods
```python
>>> import spectreapi
>>> z = spectreapi.UsernameServer('cc','username','password').get_zone_by_name('Zone1')
>>> q=z.query().detail('Attributes')
>>> for d in q.run():
... if d['ip'] is not None:
... print(d['ip'])
...
10.2.1.1
10.201.0.1
10.201.0.7
10.202.0.1
10.202.0.2
172.18.1.180
>>>
```
## Servers
A **Server** is the base class that has most of the functionality
needed to use the Spectre API. You'll instantiate a more specific
**Server** based on which authentication method you're using.
### UsernameServer
`spectreapi.UsernameServer(<server>, <username>, <password>, [<page_size>,] [<verify>])`
Where:
`<server>` = The IP address or DNS name of the Spectre Command Center
`<username>` = Username
`<password>` = Password
`<page_size>` = How many results should a GET request return at a time.
`<verify>` = Should we verify the SSL certificate of the server (True or False, defaults to False). You'll want to leave this a False unless you've given your command center an actual SSL certificate.
Behind the scenes, this makes an API call to `system/information` with basic authentication
(over https) and then uses the resulting JSESSIONID cookie for the rest of the time.
### APIKeyServer
`spectreapi.APIKeyServer(<server>, <api_key>, [, <page_size>] [, <verify>])`
Where:
`<server>` = The IP address or DNS name of the Spectre Command Center
`<api_key>` = API Key for API access. You get this via the GUI or by issuing the
`user key new <username>` command at the command center CLI.
`<page_size>` = How many results should a GET request return at a time.
`<verify>` = Should we verify the SSL certificate of the server (True or False, defaults to False). You'll want to leave this a False unless you've given your command center an actual SSL certificate.
## GET, POST, PUT, DELETE
## Notes on using the underlying Spectre API
%prep
%autosetup -n spectre-api-0.5.4
%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-spectre-api -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.5.4-1
- Package Spec generated
|