lucos-loganne-pythonclient 1.0.2__tar.gz → 1.0.4__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.
Files changed (13) hide show
  1. lucos_loganne_pythonclient-1.0.4/PKG-INFO +40 -0
  2. lucos_loganne_pythonclient-1.0.4/README.md +31 -0
  3. lucos_loganne_pythonclient-1.0.4/lucos_loganne_pythonclient.egg-info/PKG-INFO +40 -0
  4. {lucos_loganne_pythonclient-1.0.2 → lucos_loganne_pythonclient-1.0.4}/pyproject.toml +1 -1
  5. lucos_loganne_pythonclient-1.0.2/PKG-INFO +0 -11
  6. lucos_loganne_pythonclient-1.0.2/README.md +0 -2
  7. lucos_loganne_pythonclient-1.0.2/lucos_loganne_pythonclient.egg-info/PKG-INFO +0 -11
  8. {lucos_loganne_pythonclient-1.0.2 → lucos_loganne_pythonclient-1.0.4}/loganne.py +0 -0
  9. {lucos_loganne_pythonclient-1.0.2 → lucos_loganne_pythonclient-1.0.4}/lucos_loganne_pythonclient.egg-info/SOURCES.txt +0 -0
  10. {lucos_loganne_pythonclient-1.0.2 → lucos_loganne_pythonclient-1.0.4}/lucos_loganne_pythonclient.egg-info/dependency_links.txt +0 -0
  11. {lucos_loganne_pythonclient-1.0.2 → lucos_loganne_pythonclient-1.0.4}/lucos_loganne_pythonclient.egg-info/requires.txt +0 -0
  12. {lucos_loganne_pythonclient-1.0.2 → lucos_loganne_pythonclient-1.0.4}/lucos_loganne_pythonclient.egg-info/top_level.txt +0 -0
  13. {lucos_loganne_pythonclient-1.0.2 → lucos_loganne_pythonclient-1.0.4}/setup.cfg +0 -0
lucos_loganne_pythonclient-1.0.4/PKG-INFO ADDED
@@ -0,0 +1,40 @@
1
+ Metadata-Version: 2.4
2
+ Name: lucos_loganne_pythonclient
3
+ Version: 1.0.4
4
+ Summary: A python client for sending events to lucos_loganne
5
+ Classifier: Programming Language :: Python :: 3
6
+ Requires-Python: >=3.8
7
+ Description-Content-Type: text/markdown
8
+ Requires-Dist: requests>=2.28
9
+
10
+ # lucos_loganne_pythonclient
11
+ A python client for sending events to [lucos_loganne](https://github.com/lucas42/lucos_loganne).
12
+
13
+ ## Environment Variables
14
+ The following environment variables must be set for the package to function:
15
+
16
+ * `SYSTEM`: A unique identifier for the system or service sending the events. This is used as the `User-Agent` in the HTTP request and the `source` field in the loganne event.
17
+ * `LOGANNE_ENDPOINT`: The full URL of the `/events` endpoint of a running `lucos_loganne` instance.
18
+
19
+ ## API
20
+ The package exposes a single function:
21
+
22
+ ### `updateLoganne(type, humanReadable, url=None)`
23
+ Sends an event to the Loganne service.
24
+
25
+ * **type** (str, required): The type of event being logged.
26
+ * **humanReadable** (str, required): A description of the event that is easy for humans to understand.
27
+ * **url** (str, optional): A link to a human-readable page regarding the item the event pertains to. Defaults to `None`.
28
+
29
+ ## Usage
30
+ ```python
31
+ from loganne import updateLoganne
32
+
33
+ # Ensure SYSTEM and LOGANNE_ENDPOINT env vars are set
34
+ updateLoganne(
35
+ type="contactUpdated",
36
+ humanReadable="The Contact \"John Doe\" has been updated",
37
+ url="https://contacts.example.com/contact/123456"
38
+ )
39
+ ```
40
+
lucos_loganne_pythonclient-1.0.4/README.md ADDED
@@ -0,0 +1,31 @@
1
+ # lucos_loganne_pythonclient
2
+ A python client for sending events to [lucos_loganne](https://github.com/lucas42/lucos_loganne).
3
+
4
+ ## Environment Variables
5
+ The following environment variables must be set for the package to function:
6
+
7
+ * `SYSTEM`: A unique identifier for the system or service sending the events. This is used as the `User-Agent` in the HTTP request and the `source` field in the loganne event.
8
+ * `LOGANNE_ENDPOINT`: The full URL of the `/events` endpoint of a running `lucos_loganne` instance.
9
+
10
+ ## API
11
+ The package exposes a single function:
12
+
13
+ ### `updateLoganne(type, humanReadable, url=None)`
14
+ Sends an event to the Loganne service.
15
+
16
+ * **type** (str, required): The type of event being logged.
17
+ * **humanReadable** (str, required): A description of the event that is easy for humans to understand.
18
+ * **url** (str, optional): A link to a human-readable page regarding the item the event pertains to. Defaults to `None`.
19
+
20
+ ## Usage
21
+ ```python
22
+ from loganne import updateLoganne
23
+
24
+ # Ensure SYSTEM and LOGANNE_ENDPOINT env vars are set
25
+ updateLoganne(
26
+ type="contactUpdated",
27
+ humanReadable="The Contact \"John Doe\" has been updated",
28
+ url="https://contacts.example.com/contact/123456"
29
+ )
30
+ ```
31
+
lucos_loganne_pythonclient-1.0.4/lucos_loganne_pythonclient.egg-info/PKG-INFO ADDED
@@ -0,0 +1,40 @@
1
+ Metadata-Version: 2.4
2
+ Name: lucos_loganne_pythonclient
3
+ Version: 1.0.4
4
+ Summary: A python client for sending events to lucos_loganne
5
+ Classifier: Programming Language :: Python :: 3
6
+ Requires-Python: >=3.8
7
+ Description-Content-Type: text/markdown
8
+ Requires-Dist: requests>=2.28
9
+
10
+ # lucos_loganne_pythonclient
11
+ A python client for sending events to [lucos_loganne](https://github.com/lucas42/lucos_loganne).
12
+
13
+ ## Environment Variables
14
+ The following environment variables must be set for the package to function:
15
+
16
+ * `SYSTEM`: A unique identifier for the system or service sending the events. This is used as the `User-Agent` in the HTTP request and the `source` field in the loganne event.
17
+ * `LOGANNE_ENDPOINT`: The full URL of the `/events` endpoint of a running `lucos_loganne` instance.
18
+
19
+ ## API
20
+ The package exposes a single function:
21
+
22
+ ### `updateLoganne(type, humanReadable, url=None)`
23
+ Sends an event to the Loganne service.
24
+
25
+ * **type** (str, required): The type of event being logged.
26
+ * **humanReadable** (str, required): A description of the event that is easy for humans to understand.
27
+ * **url** (str, optional): A link to a human-readable page regarding the item the event pertains to. Defaults to `None`.
28
+
29
+ ## Usage
30
+ ```python
31
+ from loganne import updateLoganne
32
+
33
+ # Ensure SYSTEM and LOGANNE_ENDPOINT env vars are set
34
+ updateLoganne(
35
+ type="contactUpdated",
36
+ humanReadable="The Contact \"John Doe\" has been updated",
37
+ url="https://contacts.example.com/contact/123456"
38
+ )
39
+ ```
40
+
{lucos_loganne_pythonclient-1.0.2 → lucos_loganne_pythonclient-1.0.4}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "lucos_loganne_pythonclient"
7
- version = "1.0.2"
7
+ version = "1.0.4"
8
8
  description = "A python client for sending events to lucos_loganne"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.8"
lucos_loganne_pythonclient-1.0.2/PKG-INFO DELETED
@@ -1,11 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: lucos_loganne_pythonclient
3
- Version: 1.0.2
4
- Summary: A python client for sending events to lucos_loganne
5
- Classifier: Programming Language :: Python :: 3
6
- Requires-Python: >=3.8
7
- Description-Content-Type: text/markdown
8
- Requires-Dist: requests>=2.28
9
-
10
- # lucos_loganne_pythonclient
11
- A python client for sending events to lucos_loganne
lucos_loganne_pythonclient-1.0.2/README.md DELETED
@@ -1,2 +0,0 @@
1
- # lucos_loganne_pythonclient
2
- A python client for sending events to lucos_loganne
lucos_loganne_pythonclient-1.0.2/lucos_loganne_pythonclient.egg-info/PKG-INFO DELETED
@@ -1,11 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: lucos_loganne_pythonclient
3
- Version: 1.0.2
4
- Summary: A python client for sending events to lucos_loganne
5
- Classifier: Programming Language :: Python :: 3
6
- Requires-Python: >=3.8
7
- Description-Content-Type: text/markdown
8
- Requires-Dist: requests>=2.28
9
-
10
- # lucos_loganne_pythonclient
11
- A python client for sending events to lucos_loganne