influxdb-api-sdk 1.0.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,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2024-Present Pascal Zimmermann
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,7 @@
1
+ This project includes software originally developed by InfluxDB
2
+ and licensed under the MIT License.
3
+
4
+ Original project: https://github.com/influxdata/influxdb-python
5
+ Original license: See license file in the original project.
6
+
7
+ This fork is licensed under the Apache License 2.0.
@@ -0,0 +1,244 @@
1
+ Metadata-Version: 2.4
2
+ Name: influxdb-api-sdk
3
+ Version: 1.0.0
4
+ Summary: A InfluxDB API SDK
5
+ Author-email: Pascal Zimmermann <info@theiotstudio.com>
6
+ License: Apache-2.0 License
7
+ Project-URL: Source, https://github.com/ZPascal/influxdb_api_sdk
8
+ Project-URL: Bug Tracker, https://github.com/ZPascal/influxdb_api_sdk/issues
9
+ Project-URL: Documentation, https://zpascal.github.io/influxdb_api_sdk/
10
+ Requires-Python: >=3.10
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ License-File: NOTICE
14
+ Requires-Dist: python-dateutil
15
+ Requires-Dist: pytz
16
+ Requires-Dist: urllib3
17
+ Requires-Dist: msgpack
18
+ Provides-Extra: test
19
+ Requires-Dist: pytest>=8.3.5; extra == "test"
20
+ Requires-Dist: pytest-cov>=5.0.0; extra == "test"
21
+ Requires-Dist: pandas; extra == "test"
22
+ Requires-Dist: numpy; extra == "test"
23
+ Requires-Dist: genbadge[coverage]>=1.1.3; extra == "test"
24
+ Provides-Extra: dataframe
25
+ Requires-Dist: pandas; extra == "dataframe"
26
+ Requires-Dist: numpy; extra == "dataframe"
27
+ Provides-Extra: docs
28
+ Requires-Dist: mkdocs; extra == "docs"
29
+ Requires-Dist: mkdocs-material; extra == "docs"
30
+ Requires-Dist: mkdocstrings[python]; extra == "docs"
31
+ Provides-Extra: dev
32
+ Requires-Dist: build; extra == "dev"
33
+ Requires-Dist: setuptools>=65.0.0; extra == "dev"
34
+ Requires-Dist: wheel; extra == "dev"
35
+ Requires-Dist: ruff>=0.5.0; extra == "dev"
36
+ Requires-Dist: pytest>=8.3.5; extra == "dev"
37
+ Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
38
+ Requires-Dist: genbadge[coverage]>=1.1.3; extra == "dev"
39
+ Requires-Dist: pandas; extra == "dev"
40
+ Requires-Dist: numpy; extra == "dev"
41
+ Dynamic: license-file
42
+
43
+ # InfluxDB API SDK ![Coverage report](https://github.com/ZPascal/influxdb_api_sdk/blob/main/docs/coverage.svg)
44
+
45
+ The repository includes an SDK for the InfluxDB v1 API and the Flux compatibility layer above InfluxDB version 1.8. It is possible to interact with all publicly available InfluxDB HTTP API endpoints supported by the [influxdb-python](https://github.com/influxdata/influxdb-python) client.
46
+
47
+ ## Differences between the [influxdb-python](https://github.com/influxdata/influxdb-python) and the [influxdb_api_sdk](https://github.com/ZPascal/influxdb_api_sdk)
48
+
49
+ The `influxdb_api_sdk` is a maintained fork of the unmaintained `influxdb-python` client. The core differences are:
50
+
51
+ - Uses `urllib3` instead of `requests` for HTTP communication
52
+ - Supports msgpack encoding for more efficient data transfer
53
+ - Supports custom TCP socket options
54
+ - Supports custom SSL contexts for TLS/mTLS
55
+ - Python 3.10+ only (no Python 2 support)
56
+ - Modern `pyproject.toml`-based packaging
57
+
58
+ The core features implemented in this library:
59
+
60
+ - All public InfluxDB v1 HTTP API endpoints are supported
61
+ - Flux query support (InfluxDB 1.8+)
62
+ - Possibility to specify custom and self-signed certificates via `ssl_context`
63
+ - UDP write support
64
+ - DataFrame client for pandas integration
65
+ - msgpack response encoding support
66
+
67
+ ## Installation
68
+
69
+ Please be aware not to install the `influxdb` and `influxdb-api-sdk` packages in parallel in the same environment. This results in name clashes and it is not possible to use the InfluxDB API SDK.
70
+
71
+ ```
72
+ pip install influxdb-api-sdk
73
+ ```
74
+
75
+ For DataFrame support:
76
+
77
+ ```
78
+ pip install influxdb-api-sdk[dataframe]
79
+ ```
80
+
81
+ ## Example
82
+
83
+ ```python
84
+ from influxdb import InfluxDBClient
85
+
86
+ client = InfluxDBClient(host="localhost", port=8086, username="root", password="root", database="mydb")
87
+
88
+ # Write data
89
+ client.write_points([
90
+ {
91
+ "measurement": "cpu_load",
92
+ "tags": {"host": "server01"},
93
+ "time": "2024-01-01T00:00:00Z",
94
+ "fields": {"value": 0.64}
95
+ }
96
+ ])
97
+
98
+ # Query data
99
+ result = client.query("SELECT * FROM cpu_load")
100
+ for point in result.get_points():
101
+ print(point)
102
+
103
+ client.close()
104
+ ```
105
+
106
+ ## Context Manager
107
+
108
+ The client can be used as a context manager:
109
+
110
+ ```python
111
+ from influxdb import InfluxDBClient
112
+
113
+ with InfluxDBClient(host="localhost", port=8086, database="mydb") as client:
114
+ client.write_points([...])
115
+ ```
116
+
117
+ ## TLS / mTLS
118
+
119
+ It is possible to pass a custom `ssl_context` to the client to perform requests over HTTPS. More information can be found [here](https://docs.python.org/3/library/ssl.html#ssl.create_default_context).
120
+
121
+ ### TLS
122
+
123
+ ```python
124
+ import ssl
125
+ from influxdb import InfluxDBClient
126
+
127
+ ssl_ctx = ssl.create_default_context(
128
+ ssl.Purpose.SERVER_AUTH,
129
+ cafile="/path/to/ca.crt"
130
+ )
131
+ ssl_ctx.verify_mode = ssl.CERT_REQUIRED
132
+
133
+ client = InfluxDBClient(host="localhost", port=8086, ssl_usage=True, ssl_context=ssl_ctx)
134
+ ```
135
+
136
+ ### mTLS
137
+
138
+ ```python
139
+ import ssl
140
+ from influxdb import InfluxDBClient
141
+
142
+ ssl_ctx = ssl.create_default_context(
143
+ ssl.Purpose.SERVER_AUTH,
144
+ cafile="/path/to/ca.crt",
145
+ )
146
+ ssl_ctx.verify_mode = ssl.CERT_REQUIRED
147
+ ssl_ctx.load_cert_chain(certfile="/path/to/client.crt", keyfile="/path/to/client.key")
148
+
149
+ client = InfluxDBClient(host="localhost", port=8086, ssl_usage=True, ssl_context=ssl_ctx)
150
+ ```
151
+
152
+ ## Custom Socket Options
153
+
154
+ Custom TCP socket options can be passed to control keep-alive and other low-level settings:
155
+
156
+ ```python
157
+ import socket
158
+ from urllib3.connection import HTTPConnection
159
+ from influxdb import InfluxDBClient
160
+
161
+ socket_options = HTTPConnection.default_socket_options + [
162
+ (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
163
+ (socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 60),
164
+ (socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 15),
165
+ ]
166
+
167
+ client = InfluxDBClient(host="localhost", port=8086, socket_options=socket_options)
168
+ ```
169
+
170
+ ## Flux Queries (InfluxDB 1.8+)
171
+
172
+ ```python
173
+ from influxdb import InfluxDBClient
174
+
175
+ client = InfluxDBClient(host="localhost", port=8086)
176
+
177
+ result = client.query(
178
+ 'from(bucket: "mydb/autogen") |> range(start: -1h)',
179
+ headers={"Content-Type": "application/vnd.flux"}
180
+ )
181
+ ```
182
+
183
+ ## Development & Testing
184
+
185
+ ### Unit Tests
186
+
187
+ Unit tests run without a live InfluxDB instance (all HTTP calls are mocked):
188
+
189
+ ```bash
190
+ make test-unit
191
+ # or directly:
192
+ uv run pytest tests/unittests
193
+ ```
194
+
195
+ ### Integration Tests
196
+
197
+ Integration tests require a running InfluxDB 1.8 instance. The easiest way is to use the provided `docker-compose.yml`:
198
+
199
+ ```bash
200
+ # Start InfluxDB, run all integration tests, then stop InfluxDB
201
+ make test-integration
202
+
203
+ # Keep InfluxDB running after the tests (useful during development)
204
+ make test-integration-keep
205
+
206
+ # Run both unit and integration tests
207
+ make test-all
208
+ ```
209
+
210
+ You can also point the tests at an existing InfluxDB instance via environment variables:
211
+
212
+ | Variable | Default | Description |
213
+ |--------------------|-------------|------------------------------|
214
+ | `INFLUXDB_HOST` | `localhost` | InfluxDB hostname |
215
+ | `INFLUXDB_PORT` | `8086` | InfluxDB HTTP port |
216
+ | `INFLUXDB_USER` | `root` | Username |
217
+ | `INFLUXDB_PASSWORD`| `root` | Password |
218
+
219
+ ```bash
220
+ INFLUXDB_HOST=my-server INFLUXDB_PORT=8086 \
221
+ uv run pytest -m integration tests/integrationtests -v
222
+ ```
223
+
224
+ ### Linting
225
+
226
+ ```bash
227
+ make lint
228
+ ```
229
+
230
+ ## Contribution
231
+
232
+ If you would like to contribute something, have an improvement request, or want to make a change inside the code, please open a pull request.
233
+
234
+ ## Support
235
+
236
+ If you need support, or you encounter a bug, please don't hesitate to open an issue.
237
+
238
+ ## Donations
239
+
240
+ If you want to support my work, I ask you to take an unusual action inside the open source community. Donate the money to a non-profit organization like Doctors Without Borders or the Children's Cancer Aid. I will continue to build tools because I like them, and I am passionate about developing and sharing applications.
241
+
242
+ ## License
243
+
244
+ This product is available under the Apache 2.0 license.
@@ -0,0 +1,202 @@
1
+ # InfluxDB API SDK ![Coverage report](https://github.com/ZPascal/influxdb_api_sdk/blob/main/docs/coverage.svg)
2
+
3
+ The repository includes an SDK for the InfluxDB v1 API and the Flux compatibility layer above InfluxDB version 1.8. It is possible to interact with all publicly available InfluxDB HTTP API endpoints supported by the [influxdb-python](https://github.com/influxdata/influxdb-python) client.
4
+
5
+ ## Differences between the [influxdb-python](https://github.com/influxdata/influxdb-python) and the [influxdb_api_sdk](https://github.com/ZPascal/influxdb_api_sdk)
6
+
7
+ The `influxdb_api_sdk` is a maintained fork of the unmaintained `influxdb-python` client. The core differences are:
8
+
9
+ - Uses `urllib3` instead of `requests` for HTTP communication
10
+ - Supports msgpack encoding for more efficient data transfer
11
+ - Supports custom TCP socket options
12
+ - Supports custom SSL contexts for TLS/mTLS
13
+ - Python 3.10+ only (no Python 2 support)
14
+ - Modern `pyproject.toml`-based packaging
15
+
16
+ The core features implemented in this library:
17
+
18
+ - All public InfluxDB v1 HTTP API endpoints are supported
19
+ - Flux query support (InfluxDB 1.8+)
20
+ - Possibility to specify custom and self-signed certificates via `ssl_context`
21
+ - UDP write support
22
+ - DataFrame client for pandas integration
23
+ - msgpack response encoding support
24
+
25
+ ## Installation
26
+
27
+ Please be aware not to install the `influxdb` and `influxdb-api-sdk` packages in parallel in the same environment. This results in name clashes and it is not possible to use the InfluxDB API SDK.
28
+
29
+ ```
30
+ pip install influxdb-api-sdk
31
+ ```
32
+
33
+ For DataFrame support:
34
+
35
+ ```
36
+ pip install influxdb-api-sdk[dataframe]
37
+ ```
38
+
39
+ ## Example
40
+
41
+ ```python
42
+ from influxdb import InfluxDBClient
43
+
44
+ client = InfluxDBClient(host="localhost", port=8086, username="root", password="root", database="mydb")
45
+
46
+ # Write data
47
+ client.write_points([
48
+ {
49
+ "measurement": "cpu_load",
50
+ "tags": {"host": "server01"},
51
+ "time": "2024-01-01T00:00:00Z",
52
+ "fields": {"value": 0.64}
53
+ }
54
+ ])
55
+
56
+ # Query data
57
+ result = client.query("SELECT * FROM cpu_load")
58
+ for point in result.get_points():
59
+ print(point)
60
+
61
+ client.close()
62
+ ```
63
+
64
+ ## Context Manager
65
+
66
+ The client can be used as a context manager:
67
+
68
+ ```python
69
+ from influxdb import InfluxDBClient
70
+
71
+ with InfluxDBClient(host="localhost", port=8086, database="mydb") as client:
72
+ client.write_points([...])
73
+ ```
74
+
75
+ ## TLS / mTLS
76
+
77
+ It is possible to pass a custom `ssl_context` to the client to perform requests over HTTPS. More information can be found [here](https://docs.python.org/3/library/ssl.html#ssl.create_default_context).
78
+
79
+ ### TLS
80
+
81
+ ```python
82
+ import ssl
83
+ from influxdb import InfluxDBClient
84
+
85
+ ssl_ctx = ssl.create_default_context(
86
+ ssl.Purpose.SERVER_AUTH,
87
+ cafile="/path/to/ca.crt"
88
+ )
89
+ ssl_ctx.verify_mode = ssl.CERT_REQUIRED
90
+
91
+ client = InfluxDBClient(host="localhost", port=8086, ssl_usage=True, ssl_context=ssl_ctx)
92
+ ```
93
+
94
+ ### mTLS
95
+
96
+ ```python
97
+ import ssl
98
+ from influxdb import InfluxDBClient
99
+
100
+ ssl_ctx = ssl.create_default_context(
101
+ ssl.Purpose.SERVER_AUTH,
102
+ cafile="/path/to/ca.crt",
103
+ )
104
+ ssl_ctx.verify_mode = ssl.CERT_REQUIRED
105
+ ssl_ctx.load_cert_chain(certfile="/path/to/client.crt", keyfile="/path/to/client.key")
106
+
107
+ client = InfluxDBClient(host="localhost", port=8086, ssl_usage=True, ssl_context=ssl_ctx)
108
+ ```
109
+
110
+ ## Custom Socket Options
111
+
112
+ Custom TCP socket options can be passed to control keep-alive and other low-level settings:
113
+
114
+ ```python
115
+ import socket
116
+ from urllib3.connection import HTTPConnection
117
+ from influxdb import InfluxDBClient
118
+
119
+ socket_options = HTTPConnection.default_socket_options + [
120
+ (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
121
+ (socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 60),
122
+ (socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 15),
123
+ ]
124
+
125
+ client = InfluxDBClient(host="localhost", port=8086, socket_options=socket_options)
126
+ ```
127
+
128
+ ## Flux Queries (InfluxDB 1.8+)
129
+
130
+ ```python
131
+ from influxdb import InfluxDBClient
132
+
133
+ client = InfluxDBClient(host="localhost", port=8086)
134
+
135
+ result = client.query(
136
+ 'from(bucket: "mydb/autogen") |> range(start: -1h)',
137
+ headers={"Content-Type": "application/vnd.flux"}
138
+ )
139
+ ```
140
+
141
+ ## Development & Testing
142
+
143
+ ### Unit Tests
144
+
145
+ Unit tests run without a live InfluxDB instance (all HTTP calls are mocked):
146
+
147
+ ```bash
148
+ make test-unit
149
+ # or directly:
150
+ uv run pytest tests/unittests
151
+ ```
152
+
153
+ ### Integration Tests
154
+
155
+ Integration tests require a running InfluxDB 1.8 instance. The easiest way is to use the provided `docker-compose.yml`:
156
+
157
+ ```bash
158
+ # Start InfluxDB, run all integration tests, then stop InfluxDB
159
+ make test-integration
160
+
161
+ # Keep InfluxDB running after the tests (useful during development)
162
+ make test-integration-keep
163
+
164
+ # Run both unit and integration tests
165
+ make test-all
166
+ ```
167
+
168
+ You can also point the tests at an existing InfluxDB instance via environment variables:
169
+
170
+ | Variable | Default | Description |
171
+ |--------------------|-------------|------------------------------|
172
+ | `INFLUXDB_HOST` | `localhost` | InfluxDB hostname |
173
+ | `INFLUXDB_PORT` | `8086` | InfluxDB HTTP port |
174
+ | `INFLUXDB_USER` | `root` | Username |
175
+ | `INFLUXDB_PASSWORD`| `root` | Password |
176
+
177
+ ```bash
178
+ INFLUXDB_HOST=my-server INFLUXDB_PORT=8086 \
179
+ uv run pytest -m integration tests/integrationtests -v
180
+ ```
181
+
182
+ ### Linting
183
+
184
+ ```bash
185
+ make lint
186
+ ```
187
+
188
+ ## Contribution
189
+
190
+ If you would like to contribute something, have an improvement request, or want to make a change inside the code, please open a pull request.
191
+
192
+ ## Support
193
+
194
+ If you need support, or you encounter a bug, please don't hesitate to open an issue.
195
+
196
+ ## Donations
197
+
198
+ If you want to support my work, I ask you to take an unusual action inside the open source community. Donate the money to a non-profit organization like Doctors Without Borders or the Children's Cancer Aid. I will continue to build tools because I like them, and I am passionate about developing and sharing applications.
199
+
200
+ ## License
201
+
202
+ This product is available under the Apache 2.0 license.
@@ -0,0 +1,21 @@
1
+ # -*- coding: utf-8 -*-
2
+ """Initialize the influxdb package."""
3
+
4
+ from __future__ import absolute_import
5
+ from __future__ import division
6
+ from __future__ import print_function
7
+ from __future__ import unicode_literals
8
+
9
+ from .client import InfluxDBClient
10
+ from .dataframe_client import DataFrameClient
11
+ from .helper import SeriesHelper
12
+
13
+
14
+ __all__ = [
15
+ "InfluxDBClient",
16
+ "DataFrameClient",
17
+ "SeriesHelper",
18
+ ]
19
+
20
+
21
+ __version__ = "5.3.1"