neris-api-client 0.1.1__tar.gz → 0.1.2__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: neris_api_client
3
- Version: 0.1.1
3
+ Version: 0.1.2
4
4
  Summary: NERIS API Client
5
5
  Author-email: Ben Coleman <ben.coleman@ul.org>
6
6
  Project-URL: Homepage, https://github.com/ulfsri/neris
@@ -28,7 +28,7 @@ at instantiation. The `local` environment is intended for development use on loc
28
28
  ```python
29
29
  from neris_api_client import NerisApiClient
30
30
 
31
- client = NerisApiClient(username="neris.user", password="*******", env="dev")
31
+ client = NerisApiClient(username="neris.user@email.co", password="*******", env="dev")
32
32
 
33
33
  # Get an entity
34
34
  entity = client.get_entity("FD24027240")
@@ -36,3 +36,8 @@ entity = client.get_entity("FD24027240")
36
36
 
37
37
  API auth tokens are cached locally in `./.token_cache`. If there are auth issues first try instantiating the client with `use_cache=False`
38
38
  keyword argument or deleting the token cache.
39
+
40
+ ## Disclaimer
41
+ The models in this package are generated using [`datamodel-code-generator`](https://github.com/koxudaxi/datamodel-code-generator) and are not guaranteed
42
+ to contain all of the information present in the full specification. The generated models are used to validate request payloads prior to
43
+ API submission.
@@ -9,7 +9,7 @@ at instantiation. The `local` environment is intended for development use on loc
9
9
  ```python
10
10
  from neris_api_client import NerisApiClient
11
11
 
12
- client = NerisApiClient(username="neris.user", password="*******", env="dev")
12
+ client = NerisApiClient(username="neris.user@email.co", password="*******", env="dev")
13
13
 
14
14
  # Get an entity
15
15
  entity = client.get_entity("FD24027240")
@@ -17,3 +17,8 @@ entity = client.get_entity("FD24027240")
17
17
 
18
18
  API auth tokens are cached locally in `./.token_cache`. If there are auth issues first try instantiating the client with `use_cache=False`
19
19
  keyword argument or deleting the token cache.
20
+
21
+ ## Disclaimer
22
+ The models in this package are generated using [`datamodel-code-generator`](https://github.com/koxudaxi/datamodel-code-generator) and are not guaranteed
23
+ to contain all of the information present in the full specification. The generated models are used to validate request payloads prior to
24
+ API submission.
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "neris_api_client"
7
- version = "0.1.1"
7
+ version = "0.1.2"
8
8
  authors = [
9
9
  { name="Ben Coleman", email="ben.coleman@ul.org" },
10
10
  ]
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: neris_api_client
3
- Version: 0.1.1
3
+ Version: 0.1.2
4
4
  Summary: NERIS API Client
5
5
  Author-email: Ben Coleman <ben.coleman@ul.org>
6
6
  Project-URL: Homepage, https://github.com/ulfsri/neris
@@ -28,7 +28,7 @@ at instantiation. The `local` environment is intended for development use on loc
28
28
  ```python
29
29
  from neris_api_client import NerisApiClient
30
30
 
31
- client = NerisApiClient(username="neris.user", password="*******", env="dev")
31
+ client = NerisApiClient(username="neris.user@email.co", password="*******", env="dev")
32
32
 
33
33
  # Get an entity
34
34
  entity = client.get_entity("FD24027240")
@@ -36,3 +36,8 @@ entity = client.get_entity("FD24027240")
36
36
 
37
37
  API auth tokens are cached locally in `./.token_cache`. If there are auth issues first try instantiating the client with `use_cache=False`
38
38
  keyword argument or deleting the token cache.
39
+
40
+ ## Disclaimer
41
+ The models in this package are generated using [`datamodel-code-generator`](https://github.com/koxudaxi/datamodel-code-generator) and are not guaranteed
42
+ to contain all of the information present in the full specification. The generated models are used to validate request payloads prior to
43
+ API submission.