argus-api-client 0.4.3__tar.gz → 0.6.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,387 @@
1
+ Metadata-Version: 2.1
2
+ Name: argus-api-client
3
+ Version: 0.6.0
4
+ Summary: A Python API client library for the Argus alert aggregator server
5
+ Author-email: Sikt - Kunnskapssektorens Tjenesteleverandør <kontakt@sikt.no>
6
+ License:
7
+ Apache License
8
+ Version 2.0, January 2004
9
+ https://www.apache.org/licenses/
10
+
11
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
12
+
13
+ 1. Definitions.
14
+
15
+ "License" shall mean the terms and conditions for use, reproduction,
16
+ and distribution as defined by Sections 1 through 9 of this document.
17
+
18
+ "Licensor" shall mean the copyright owner or entity authorized by
19
+ the copyright owner that is granting the License.
20
+
21
+ "Legal Entity" shall mean the union of the acting entity and all
22
+ other entities that control, are controlled by, or are under common
23
+ control with that entity. For the purposes of this definition,
24
+ "control" means (i) the power, direct or indirect, to cause the
25
+ direction or management of such entity, whether by contract or
26
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
27
+ outstanding shares, or (iii) beneficial ownership of such entity.
28
+
29
+ "You" (or "Your") shall mean an individual or Legal Entity
30
+ exercising permissions granted by this License.
31
+
32
+ "Source" form shall mean the preferred form for making modifications,
33
+ including but not limited to software source code, documentation
34
+ source, and configuration files.
35
+
36
+ "Object" form shall mean any form resulting from mechanical
37
+ transformation or translation of a Source form, including but
38
+ not limited to compiled object code, generated documentation,
39
+ and conversions to other media types.
40
+
41
+ "Work" shall mean the work of authorship, whether in Source or
42
+ Object form, made available under the License, as indicated by a
43
+ copyright notice that is included in or attached to the work
44
+ (an example is provided in the Appendix below).
45
+
46
+ "Derivative Works" shall mean any work, whether in Source or Object
47
+ form, that is based on (or derived from) the Work and for which the
48
+ editorial revisions, annotations, elaborations, or other modifications
49
+ represent, as a whole, an original work of authorship. For the purposes
50
+ of this License, Derivative Works shall not include works that remain
51
+ separable from, or merely link (or bind by name) to the interfaces of,
52
+ the Work and Derivative Works thereof.
53
+
54
+ "Contribution" shall mean any work of authorship, including
55
+ the original version of the Work and any modifications or additions
56
+ to that Work or Derivative Works thereof, that is intentionally
57
+ submitted to Licensor for inclusion in the Work by the copyright owner
58
+ or by an individual or Legal Entity authorized to submit on behalf of
59
+ the copyright owner. For the purposes of this definition, "submitted"
60
+ means any form of electronic, verbal, or written communication sent
61
+ to the Licensor or its representatives, including but not limited to
62
+ communication on electronic mailing lists, source code control systems,
63
+ and issue tracking systems that are managed by, or on behalf of, the
64
+ Licensor for the purpose of discussing and improving the Work, but
65
+ excluding communication that is conspicuously marked or otherwise
66
+ designated in writing by the copyright owner as "Not a Contribution."
67
+
68
+ "Contributor" shall mean Licensor and any individual or Legal Entity
69
+ on behalf of whom a Contribution has been received by Licensor and
70
+ subsequently incorporated within the Work.
71
+
72
+ 2. Grant of Copyright License. Subject to the terms and conditions of
73
+ this License, each Contributor hereby grants to You a perpetual,
74
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75
+ copyright license to reproduce, prepare Derivative Works of,
76
+ publicly display, publicly perform, sublicense, and distribute the
77
+ Work and such Derivative Works in Source or Object form.
78
+
79
+ 3. Grant of Patent License. Subject to the terms and conditions of
80
+ this License, each Contributor hereby grants to You a perpetual,
81
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82
+ (except as stated in this section) patent license to make, have made,
83
+ use, offer to sell, sell, import, and otherwise transfer the Work,
84
+ where such license applies only to those patent claims licensable
85
+ by such Contributor that are necessarily infringed by their
86
+ Contribution(s) alone or by combination of their Contribution(s)
87
+ with the Work to which such Contribution(s) was submitted. If You
88
+ institute patent litigation against any entity (including a
89
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
90
+ or a Contribution incorporated within the Work constitutes direct
91
+ or contributory patent infringement, then any patent licenses
92
+ granted to You under this License for that Work shall terminate
93
+ as of the date such litigation is filed.
94
+
95
+ 4. Redistribution. You may reproduce and distribute copies of the
96
+ Work or Derivative Works thereof in any medium, with or without
97
+ modifications, and in Source or Object form, provided that You
98
+ meet the following conditions:
99
+
100
+ (a) You must give any other recipients of the Work or
101
+ Derivative Works a copy of this License; and
102
+
103
+ (b) You must cause any modified files to carry prominent notices
104
+ stating that You changed the files; and
105
+
106
+ (c) You must retain, in the Source form of any Derivative Works
107
+ that You distribute, all copyright, patent, trademark, and
108
+ attribution notices from the Source form of the Work,
109
+ excluding those notices that do not pertain to any part of
110
+ the Derivative Works; and
111
+
112
+ (d) If the Work includes a "NOTICE" text file as part of its
113
+ distribution, then any Derivative Works that You distribute must
114
+ include a readable copy of the attribution notices contained
115
+ within such NOTICE file, excluding those notices that do not
116
+ pertain to any part of the Derivative Works, in at least one
117
+ of the following places: within a NOTICE text file distributed
118
+ as part of the Derivative Works; within the Source form or
119
+ documentation, if provided along with the Derivative Works; or,
120
+ within a display generated by the Derivative Works, if and
121
+ wherever such third-party notices normally appear. The contents
122
+ of the NOTICE file are for informational purposes only and
123
+ do not modify the License. You may add Your own attribution
124
+ notices within Derivative Works that You distribute, alongside
125
+ or as an addendum to the NOTICE text from the Work, provided
126
+ that such additional attribution notices cannot be construed
127
+ as modifying the License.
128
+
129
+ You may add Your own copyright statement to Your modifications and
130
+ may provide additional or different license terms and conditions
131
+ for use, reproduction, or distribution of Your modifications, or
132
+ for any such Derivative Works as a whole, provided Your use,
133
+ reproduction, and distribution of the Work otherwise complies with
134
+ the conditions stated in this License.
135
+
136
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
137
+ any Contribution intentionally submitted for inclusion in the Work
138
+ by You to the Licensor shall be under the terms and conditions of
139
+ this License, without any additional terms or conditions.
140
+ Notwithstanding the above, nothing herein shall supersede or modify
141
+ the terms of any separate license agreement you may have executed
142
+ with Licensor regarding such Contributions.
143
+
144
+ 6. Trademarks. This License does not grant permission to use the trade
145
+ names, trademarks, service marks, or product names of the Licensor,
146
+ except as required for reasonable and customary use in describing the
147
+ origin of the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty. Unless required by applicable law or
150
+ agreed to in writing, Licensor provides the Work (and each
151
+ Contributor provides its Contributions) on an "AS IS" BASIS,
152
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
153
+ implied, including, without limitation, any warranties or conditions
154
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
155
+ PARTICULAR PURPOSE. You are solely responsible for determining the
156
+ appropriateness of using or redistributing the Work and assume any
157
+ risks associated with Your exercise of permissions under this License.
158
+
159
+ 8. Limitation of Liability. In no event and under no legal theory,
160
+ whether in tort (including negligence), contract, or otherwise,
161
+ unless required by applicable law (such as deliberate and grossly
162
+ negligent acts) or agreed to in writing, shall any Contributor be
163
+ liable to You for damages, including any direct, indirect, special,
164
+ incidental, or consequential damages of any character arising as a
165
+ result of this License or out of the use or inability to use the
166
+ Work (including but not limited to damages for loss of goodwill,
167
+ work stoppage, computer failure or malfunction, or any and all
168
+ other commercial damages or losses), even if such Contributor
169
+ has been advised of the possibility of such damages.
170
+
171
+ 9. Accepting Warranty or Additional Liability. While redistributing
172
+ the Work or Derivative Works thereof, You may choose to offer,
173
+ and charge a fee for, acceptance of support, warranty, indemnity,
174
+ or other liability obligations and/or rights consistent with this
175
+ License. However, in accepting such obligations, You may act only
176
+ on Your own behalf and on Your sole responsibility, not on behalf
177
+ of any other Contributor, and only if You agree to indemnify,
178
+ defend, and hold each Contributor harmless for any liability
179
+ incurred by, or claims asserted against, such Contributor by reason
180
+ of your accepting any such warranty or additional liability.
181
+
182
+ END OF TERMS AND CONDITIONS
183
+
184
+ Copyright 2020 Uninett AS
185
+
186
+ Licensed under the Apache License, Version 2.0 (the "License");
187
+ you may not use this file except in compliance with the License.
188
+ You may obtain a copy of the License at
189
+
190
+ https://www.apache.org/licenses/LICENSE-2.0
191
+
192
+ Unless required by applicable law or agreed to in writing, software
193
+ distributed under the License is distributed on an "AS IS" BASIS,
194
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
195
+ See the License for the specific language governing permissions and
196
+ limitations under the License.
197
+
198
+ Classifier: License :: OSI Approved :: Apache Software License
199
+ Classifier: Programming Language :: Python :: 3
200
+ Classifier: Programming Language :: Python :: 3.8
201
+ Classifier: Programming Language :: Python :: 3.9
202
+ Classifier: Programming Language :: Python :: 3.10
203
+ Classifier: Programming Language :: Python :: 3.11
204
+ Requires-Python: >=3.8
205
+ Description-Content-Type: text/markdown
206
+ License-File: LICENSE
207
+ Requires-Dist: simple_rest_client
208
+ Requires-Dist: iso8601
209
+ Provides-Extra: dev
210
+ Requires-Dist: build; extra == "dev"
211
+ Requires-Dist: coverage; extra == "dev"
212
+ Requires-Dist: ipython; extra == "dev"
213
+ Requires-Dist: isort; extra == "dev"
214
+ Requires-Dist: pre-commit; extra == "dev"
215
+ Requires-Dist: pytest; extra == "dev"
216
+ Requires-Dist: ruff; extra == "dev"
217
+ Requires-Dist: tox; extra == "dev"
218
+ Requires-Dist: twine; extra == "dev"
219
+
220
+ # Argus API Client
221
+ [![test badge](https://img.shields.io/github/actions/workflow/status/Uninett/pyargus/tox.yml?branch=master)](https://github.com/Uninett/pyargus/actions)
222
+ [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
223
+
224
+ This is the official Python client library for the
225
+ [Argus](https://github.com/Uninett/Argus) API server.
226
+
227
+ The Argus server is an incident registry, capable of aggregating alerts from
228
+ multiple source systems. Argus also can send event notifications (via e-mail,
229
+ SMS, etc.) when incidents are created or resolved.
230
+
231
+ ## Usage examples
232
+
233
+ The pyargus library models [the official API endoints of
234
+ Argus](https://argus-server.readthedocs.io/en/latest/api.html) as methods on an
235
+ API client object.
236
+
237
+ At the moment, only the methods and models needed to interact with
238
+ incident-related endpoints are supported.
239
+
240
+ The `Client` class is found in `pyargus.client`, and the various supported data
241
+ models, such as `Incident`, `Event`, `Acknowledgement` and `SourceSystem`, are
242
+ implemented in `pyargus.models`.
243
+
244
+ ### Listing open incidents that have not been acknowledged
245
+
246
+ ```pycon
247
+ >>> from pyargus.client import Client
248
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
249
+ >>> for incident in c.get_incidents(open=True, acked=False):
250
+ ... print(incident)
251
+ ...
252
+ Incident(pk=4, start_time=datetime.datetime(2021, 4, 4, 16, 37, 43, 293726, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202430', details_url='http://localhost/search/event/202430', description='uninett-gsw2 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'room': '100', 'organization': 'uninett.srv', 'host': 'uninett-gsw2.uninett.no'}, stateful=True, open=True, acked=False)
253
+ Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202429', details_url='http://localhost/search/event/202429', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
254
+ Incident(pk=2, start_time=datetime.datetime(2017, 8, 31, 14, 58, 31, 118794, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='184296', details_url='http://localhost/search/event/184296', description='Link DOWN on Gi0/3 at oldsmobile.lab (Simple is better than complex)', level=5, ticket_url='', tags={'room': '113', 'location': 'Teknobyen Innovasjonssenter', 'organization': 'uninett.testlab', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'linkState', 'alert_type': 'linkDown', 'host': 'oldsmobile.lab.uninett.no', 'interface': 'Gi0/3'}, stateful=True, open=True, acked=False)
255
+ ```
256
+
257
+ As you can see, the arguments given to `get_incidents()` are translated
258
+ verbatim into the arguments supported by the `/incidents` endpoint in the API.
259
+
260
+ ### List only "my" incidents
261
+
262
+ The incidents API also has an `/incidents/mine` endpoint, which works just like
263
+ the `/incidents` endpoint, but searches only the incidents that were posted
264
+ by the connecting user. This is useful for glue services, when they need to
265
+ compare the list of open Argus incidents it has produced with the current list
266
+ of active alerts in its source system.
267
+
268
+ Example:
269
+
270
+ ```pycon
271
+ >>> from pyargus.client import Client
272
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
273
+ >>> for incident in c.get_my_incidents(open=True, acked=False):
274
+ ... print(incident)
275
+ ...
276
+ Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=3, name='foobar, type='nav', user=4, base_url='http://localhost/'), source_incident_id='2716057', details_url='http://localhost/search/event/2716057', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
277
+ ```
278
+
279
+ ### Post a new incident
280
+
281
+ ```pycon
282
+ >>> from pyargus.client import Client
283
+ >>> from pyargus.models import Incident
284
+ >>> from datetime import datetime
285
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
286
+ >>> i = Incident(
287
+ ... description="The earth was demolished to make way for a hyperspace bypass",
288
+ ... start_time=datetime.now(),
289
+ ... tags={
290
+ ... "host": "earth.example.org",
291
+ ... }
292
+ ... )
293
+ >>> c.post_incident(i)
294
+ Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=5, ticket_url='', tags={'host': 'earth.example.org'}, stateful=False, open=False, acked=False)
295
+ ```
296
+
297
+ The `post_incident()` method returns the full `Incident` record, as stored in
298
+ Argus. If you need it, you can get the incident ID from the the primary key
299
+ attribute `pk`, in case you need to address it directly later.
300
+
301
+ ### Close an existing incident
302
+
303
+ Incidents are closed by posting a *END* type event to an incident's event
304
+ log, with an optional timestamp. The `Client` class provides the follow
305
+ convenience method for this operation:
306
+
307
+ ```pycon
308
+ >>> from pyargus.client import Client
309
+ >>> from datetime import datetime
310
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
311
+ >>> c.resolve_incident(incident=8, description="The demolition was cancelled", timestamp=datetime.now())
312
+ Event(pk=10, actor='testnav', description='The demolition was cancelled', incident=8, received=datetime.datetime(2021, 4, 22, 11, 47, 11, 978438, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), timestamp=datetime.datetime(2021, 4, 22, 11, 47, 11, 946076, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), type='END')
313
+ ```
314
+
315
+ ### Modify an existing incident
316
+
317
+ Argus does not allow modification of most incident attributes, but things
318
+ like the tag list can be changed. Modifications are made by constructing an
319
+ `Incident` object with the `pk` attribute set to the id of the incident you
320
+ wish you modify, and then adding values to the attributes you wish to modify:
321
+
322
+ ```pycon
323
+ >>> from pyargus.client import Client
324
+ >>> from pyargus.models import Incident
325
+ >>> from datetime import datetime
326
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
327
+ >>> i = Incident(
328
+ ... pk=8,
329
+ ... tags={
330
+ ... "host": "earth.example.org",
331
+ ... "location": "Milky way",
332
+ ... }
333
+ ... )
334
+ >>> c.update_incident(i)
335
+ Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=None, ticket_url='', tags={'host': 'earth.example.org', 'location': 'Milky way'}, stateful=False, open=False, acked=False)
336
+
337
+ ```
338
+
339
+ ### Stateless incidents
340
+
341
+ Argus supports a concept of "stateless" incidents. Stateless incidents
342
+ represent single points in time, and do not have an end time. To explicitly
343
+ create stateless incidents, set the `end_time` attribute to the STATELESS
344
+ sentinel, like so:
345
+
346
+ ```python
347
+ from datetime import datetime
348
+ from pyargus.models import Incident, STATELESS
349
+
350
+ stateless_incident = Incident(
351
+ description="Something happened",
352
+ start_time=datetime.now(),
353
+ end_time=STATELESS
354
+ )
355
+ ```
356
+
357
+
358
+ ### Get a new authentication token
359
+
360
+ If your argus server is running version 1.29.0 or newer you can request to get
361
+ a new token (with a new expiration date) via API version 2. The token you are
362
+ using to access the server with must still be valid.
363
+
364
+ ```python
365
+ tokenobj = c.refresh_token()
366
+ c = Client(api_root_url="https://argus.example.org/api/v2", token=tokenobj.token)
367
+ # save the contents of tokenobj in an environment variable, config file or
368
+ # secrets file so that it is not lost on program exit
369
+ ```
370
+
371
+ ## BUGS
372
+
373
+ * Doesn't provide high-level error handling yet.
374
+
375
+ ## Development
376
+
377
+ ### Code style
378
+
379
+ Pyargus uses *ruff* as a source code formatter. Ruff is part of the optional dev dependencies listed in
380
+ [pyproject.toml](./pyproject.toml)
381
+
382
+ A pre-commit hook will format new code automatically before committing.
383
+ To enable this pre-commit hook, run
384
+
385
+ ```console
386
+ $ pre-commit install
387
+ ```
@@ -1,20 +1,6 @@
1
- Metadata-Version: 2.1
2
- Name: argus-api-client
3
- Version: 0.4.3
4
- Summary: A Python API client library for the Argus alert aggregator server
5
- Home-page: https://github.com/Uninett/pyargus
6
- Author: Morten Brekkevold
7
- License: Apache-2.0
8
- Keywords: api,argus,client
9
- Platform: UNKNOWN
10
- Classifier: License :: OSI Approved :: Apache Software License
11
- Classifier: Programming Language :: Python :: 3
12
- Classifier: Programming Language :: Python :: 3.7
13
- Requires-Python: <4,>=3.7
14
- Description-Content-Type: text/markdown
15
- License-File: LICENSE
16
-
17
1
  # Argus API Client
2
+ [![test badge](https://img.shields.io/github/actions/workflow/status/Uninett/pyargus/tox.yml?branch=master)](https://github.com/Uninett/pyargus/actions)
3
+ [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
18
4
 
19
5
  This is the official Python client library for the
20
6
  [Argus](https://github.com/Uninett/Argus) API server.
@@ -34,13 +20,13 @@ incident-related endpoints are supported.
34
20
 
35
21
  The `Client` class is found in `pyargus.client`, and the various supported data
36
22
  models, such as `Incident`, `Event`, `Acknowledgement` and `SourceSystem`, are
37
- implemented in `pyargus.models.
23
+ implemented in `pyargus.models`.
38
24
 
39
25
  ### Listing open incidents that have not been acknowledged
40
26
 
41
27
  ```pycon
42
28
  >>> from pyargus.client import Client
43
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
29
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
44
30
  >>> for incident in c.get_incidents(open=True, acked=False):
45
31
  ... print(incident)
46
32
  ...
@@ -55,7 +41,7 @@ verbatim into the arguments supported by the `/incidents` endpoint in the API.
55
41
  ### List only "my" incidents
56
42
 
57
43
  The incidents API also has an `/incidents/mine` endpoint, which works just like
58
- the `/incidents` endpoint, but searches onl only the incidents that were posted
44
+ the `/incidents` endpoint, but searches only the incidents that were posted
59
45
  by the connecting user. This is useful for glue services, when they need to
60
46
  compare the list of open Argus incidents it has produced with the current list
61
47
  of active alerts in its source system.
@@ -64,7 +50,7 @@ Example:
64
50
 
65
51
  ```pycon
66
52
  >>> from pyargus.client import Client
67
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
53
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
68
54
  >>> for incident in c.get_my_incidents(open=True, acked=False):
69
55
  ... print(incident)
70
56
  ...
@@ -77,7 +63,7 @@ Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzin
77
63
  >>> from pyargus.client import Client
78
64
  >>> from pyargus.models import Incident
79
65
  >>> from datetime import datetime
80
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
66
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
81
67
  >>> i = Incident(
82
68
  ... description="The earth was demolished to make way for a hyperspace bypass",
83
69
  ... start_time=datetime.now(),
@@ -102,14 +88,14 @@ convenience method for this operation:
102
88
  ```pycon
103
89
  >>> from pyargus.client import Client
104
90
  >>> from datetime import datetime
105
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
91
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
106
92
  >>> c.resolve_incident(incident=8, description="The demolition was cancelled", timestamp=datetime.now())
107
93
  Event(pk=10, actor='testnav', description='The demolition was cancelled', incident=8, received=datetime.datetime(2021, 4, 22, 11, 47, 11, 978438, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), timestamp=datetime.datetime(2021, 4, 22, 11, 47, 11, 946076, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), type='END')
108
94
  ```
109
95
 
110
96
  ### Modify an existing incident
111
97
 
112
- Argus does not allow modification of most an incident's attributes, but things
98
+ Argus does not allow modification of most incident attributes, but things
113
99
  like the tag list can be changed. Modifications are made by constructing an
114
100
  `Incident` object with the `pk` attribute set to the id of the incident you
115
101
  wish you modify, and then adding values to the attributes you wish to modify:
@@ -118,7 +104,7 @@ wish you modify, and then adding values to the attributes you wish to modify:
118
104
  >>> from pyargus.client import Client
119
105
  >>> from pyargus.models import Incident
120
106
  >>> from datetime import datetime
121
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
107
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
122
108
  >>> i = Incident(
123
109
  ... pk=8,
124
110
  ... tags={
@@ -149,8 +135,34 @@ stateless_incident = Incident(
149
135
  )
150
136
  ```
151
137
 
138
+
139
+ ### Get a new authentication token
140
+
141
+ If your argus server is running version 1.29.0 or newer you can request to get
142
+ a new token (with a new expiration date) via API version 2. The token you are
143
+ using to access the server with must still be valid.
144
+
145
+ ```python
146
+ tokenobj = c.refresh_token()
147
+ c = Client(api_root_url="https://argus.example.org/api/v2", token=tokenobj.token)
148
+ # save the contents of tokenobj in an environment variable, config file or
149
+ # secrets file so that it is not lost on program exit
150
+ ```
151
+
152
152
  ## BUGS
153
153
 
154
154
  * Doesn't provide high-level error handling yet.
155
155
 
156
+ ## Development
157
+
158
+ ### Code style
159
+
160
+ Pyargus uses *ruff* as a source code formatter. Ruff is part of the optional dev dependencies listed in
161
+ [pyproject.toml](./pyproject.toml)
156
162
 
163
+ A pre-commit hook will format new code automatically before committing.
164
+ To enable this pre-commit hook, run
165
+
166
+ ```console
167
+ $ pre-commit install
168
+ ```
@@ -0,0 +1,51 @@
1
+ [project]
2
+ name = "argus-api-client"
3
+ dynamic = ["version"]
4
+ description = "A Python API client library for the Argus alert aggregator server"
5
+ readme = "README.md"
6
+ authors = [{name="Sikt - Kunnskapssektorens Tjenesteleverandør", email="kontakt@sikt.no"}]
7
+ requires-python = ">=3.8"
8
+ license = {file = "LICENSE"}
9
+ classifiers = [
10
+ "License :: OSI Approved :: Apache Software License",
11
+ "Programming Language :: Python :: 3",
12
+ "Programming Language :: Python :: 3.8",
13
+ "Programming Language :: Python :: 3.9",
14
+ "Programming Language :: Python :: 3.10",
15
+ "Programming Language :: Python :: 3.11",
16
+ ]
17
+ dependencies = [
18
+ "simple_rest_client",
19
+ "iso8601",
20
+ ]
21
+
22
+ [project.optional-dependencies]
23
+ dev = [
24
+ "build",
25
+ "coverage",
26
+ "ipython",
27
+ "isort",
28
+ "pre-commit",
29
+ "pytest",
30
+ "ruff",
31
+ "tox",
32
+ "twine",
33
+ ]
34
+
35
+ [tool.setuptools.dynamic]
36
+ version = {attr = "pyargus.VERSION"}
37
+
38
+ [tool.setuptools.packages.find]
39
+ where = ["src"]
40
+ exclude = ["tests*"]
41
+
42
+ [tool.ruff]
43
+ line-length = 88
44
+ extend-exclude = [
45
+ ".egg-info",
46
+ ]
47
+ output-format = "full"
48
+
49
+ [tool.ruff.lint]
50
+ select = ["E4", "E7", "E9", "F4", "F5", "F6", "F7", "F8", "F9"]
51
+ ignore = ["F403", "F405"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+