Debian Codegraph @

PKG-INFO

raw
1 Metadata-Version: 2.1
2 Name: influxdb
3 Version: 5.3.2
4 Summary: InfluxDB client
5 Home-page: https://github.com/influxdb/influxdb-python
6 License: MIT License
7 Classifier: Development Status :: 3 - Alpha
8 Classifier: Intended Audience :: Developers
9 Classifier: License :: OSI Approved :: MIT License
10 Classifier: Operating System :: OS Independent
11 Classifier: Programming Language :: Python
12 Classifier: Programming Language :: Python :: 2.7
13 Classifier: Programming Language :: Python :: 3
14 Classifier: Programming Language :: Python :: 3.4
15 Classifier: Programming Language :: Python :: 3.5
16 Classifier: Programming Language :: Python :: 3.6
17 Classifier: Topic :: Software Development :: Libraries
18 Classifier: Topic :: Software Development :: Libraries :: Python Modules
19 License-File: LICENSE
20 Requires-Dist: python-dateutil>=2.6.0
21 Requires-Dist: pytz
22 Requires-Dist: requests>=2.17.0
23 Requires-Dist: six>=1.10.0
24 Requires-Dist: msgpack
25 Provides-Extra: test
26 Requires-Dist: nose; extra == "test"
27 Requires-Dist: nose-cov; extra == "test"
28 Requires-Dist: mock; extra == "test"
29 Requires-Dist: requests-mock; extra == "test"
30
31 The v1 client libraries for InfluxDB were typically developed and maintained by
32 community members. For InfluxDB 3.0 users, this library is succeeded by the
33 lightweight `v3 client library <https://github.com/InfluxCommunity/influxdb3-python>`_.
34 For InfluxDB 2.0 users, look at the `v2 client library
35 <https://github.com/influxdata/influxdb-client-python>`_.
36
37 If there are still users of this v1 client library, and they or somebody else
38 are willing to keep them updated with security fixes at a minimum please reach
39 out on the `Community Forums <https://community.influxdata.com/>`_ or
40 `InfluxData Slack <https://influxdata.com/slack>`_.
41
42 InfluxDB-Python
43 ===============
44
45 .. image:: https://travis-ci.org/influxdata/influxdb-python.svg?branch=master
46 :target: https://travis-ci.org/influxdata/influxdb-python
47 .. image:: https://readthedocs.org/projects/influxdb-python/badge/?version=latest&style
48 :target: http://influxdb-python.readthedocs.org/
49 :alt: Documentation Status
50
51 .. image:: https://img.shields.io/coveralls/influxdata/influxdb-python.svg
52 :target: https://coveralls.io/r/influxdata/influxdb-python
53 :alt: Coverage
54
55 .. image:: https://img.shields.io/pypi/v/influxdb.svg
56 :target: https://pypi.python.org/pypi/influxdb
57 :alt: PyPI Status
58
59 InfluxDB-Python is a client for interacting with InfluxDB_.
60
61 **Note: This library is for use with InfluxDB 1.x. For connecting to InfluxDB 2.x instances, please use the the** `influxdb-client-python <https://github.com/influxdata/influxdb-client-python>`_ **client.**
62
63 Development of this library is maintained by:
64
65 +-----------+-------------------------------+
66 | Github ID | URL |
67 +===========+===============================+
68 | @aviau | (https://github.com/aviau) |
69 +-----------+-------------------------------+
70 | @xginn8 | (https://github.com/xginn8) |
71 +-----------+-------------------------------+
72 | @sebito91 | (https://github.com/sebito91) |
73 +-----------+-------------------------------+
74
75 .. _readme-about:
76
77 InfluxDB is an open-source distributed time series database, find more about InfluxDB_ at https://docs.influxdata.com/influxdb/latest
78
79
80 .. _installation:
81
82 InfluxDB pre v1.1.0 users
83 -------------------------
84
85 This module is tested with InfluxDB versions: v1.2.4, v1.3.9, v1.4.3, v1.5.4, v1.6.4, and 1.7.4.
86
87 Those users still on InfluxDB v0.8.x users may still use the legacy client by importing ``from influxdb.influxdb08 import InfluxDBClient``.
88
89 Installation
90 ------------
91
92 Install, upgrade and uninstall influxdb-python with these commands::
93
94 $ pip install influxdb
95 $ pip install --upgrade influxdb
96 $ pip uninstall influxdb
97
98 On Debian/Ubuntu, you can install it with this command::
99
100 $ sudo apt-get install python-influxdb
101
102 Dependencies
103 ------------
104
105 The influxdb-python distribution is supported and tested on Python 2.7, 3.5, 3.6, 3.7, PyPy and PyPy3.
106
107 **Note:** Python <3.5 are currently untested. See ``.travis.yml``.
108
109 Main dependency is:
110
111 - Requests: HTTP library for human beings (http://docs.python-requests.org/)
112
113
114 Additional dependencies are:
115
116 - pandas: for writing from and reading to DataFrames (http://pandas.pydata.org/)
117 - Sphinx: Tool to create and manage the documentation (http://sphinx-doc.org/)
118 - Nose: to auto-discover tests (http://nose.readthedocs.org/en/latest/)
119 - Mock: to mock tests (https://pypi.python.org/pypi/mock)
120
121
122 Documentation
123 -------------
124
125 Documentation is available at https://influxdb-python.readthedocs.io/en/latest/.
126
127 You will need Sphinx_ installed to generate the documentation.
128
129 The documentation can be generated by running::
130
131 $ tox -e docs
132
133
134 Generated documentation can be found in the *docs/build/html/* directory.
135
136
137 Examples
138 --------
139
140 Here's a basic example (for more see the examples directory)::
141
142 $ python
143
144 >>> from influxdb import InfluxDBClient
145
146 >>> json_body = [
147 {
148 "measurement": "cpu_load_short",
149 "tags": {
150 "host": "server01",
151 "region": "us-west"
152 },
153 "time": "2009-11-10T23:00:00Z",
154 "fields": {
155 "value": 0.64
156 }
157 }
158 ]
159
160 >>> client = InfluxDBClient('localhost', 8086, 'root', 'root', 'example')
161
162 >>> client.create_database('example')
163
164 >>> client.write_points(json_body)
165
166 >>> result = client.query('select value from cpu_load_short;')
167
168 >>> print("Result: {0}".format(result))
169
170
171 Testing
172 -------
173
174 Make sure you have tox by running the following::
175
176 $ pip install tox
177
178 To test influxdb-python with multiple version of Python, you can use Tox_::
179
180 $ tox
181
182
183 Support
184 -------
185
186 For issues with, questions about, or feedback for InfluxDB_, please look into
187 our community page: http://influxdb.com/community/.
188
189 We are also lurking on the following:
190
191 - #influxdb on irc.freenode.net
192 - #influxdb on gophers.slack.com
193
194
195 Development
196 -----------
197
198 All development is done on Github_. Use Issues_ to report
199 problems or submit contributions.
200
201 .. _Github: https://github.com/influxdb/influxdb-python/
202 .. _Issues: https://github.com/influxdb/influxdb-python/issues
203
204 Please note that we WILL get to your questions/issues/concerns as quickly as possible. We maintain many
205 software repositories and sometimes things may get pushed to the backburner. Please don't take offense,
206 we will do our best to reply as soon as possible!
207
208
209 Source code
210 -----------
211
212 The source code is currently available on Github: https://github.com/influxdata/influxdb-python
213
214
215 TODO
216 ----
217
218 The TODO/Roadmap can be found in Github bug tracker: https://github.com/influxdata/influxdb-python/issues
219
220
221 .. _InfluxDB: https://influxdata.com/time-series-platform/influxdb/
222 .. _Sphinx: http://sphinx.pocoo.org/
223 .. _Tox: https://tox.readthedocs.org