Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings
This repository was archived by the owner on Oct 29, 2024. It is now read-only.

Commit bbe80ed

Browse filesBrowse files
jstirnamanjstirnaman
authored
Update docs (#929)
* chore(docs): Update version advice and tox build requirements: - Updates the version advice and removes the succession statement to be consistent with the OSS 1.11 release. - Adds explicit relations to v2 and v3. - Removes redundancies. - Fixes formatting errors reported by the linter. - Updates dependencies for docs build. * fix(docs): mention 1.x compat endpoints in 2.x
1 parent 37ff905 commit bbe80ed
Copy full SHA for bbe80ed

File tree

8 files changed

+65
-47
lines changed
Filter options

8 files changed

+65
-47
lines changed

‎README.rst

Copy file name to clipboardExpand all lines: README.rst
+43-35
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
1-
The v1 client libraries for InfluxDB were typically developed and maintained by
2-
community members. For InfluxDB 3.0 users, this library is succeeded by the
3-
lightweight `v3 client library <https://github.com/InfluxCommunity/influxdb3-python>`_.
4-
For InfluxDB 2.0 users, look at the `v2 client library
5-
<https://github.com/influxdata/influxdb-client-python>`_.
6-
7-
If there are still users of this v1 client library, and they or somebody else
8-
are willing to keep them updated with security fixes at a minimum please reach
9-
out on the `Community Forums <https://community.influxdata.com/>`_ or
10-
`InfluxData Slack <https://influxdata.com/slack>`_.
11-
121
InfluxDB-Python
132
===============
143

@@ -26,38 +15,45 @@ InfluxDB-Python
2615
:target: https://pypi.python.org/pypi/influxdb
2716
:alt: PyPI Status
2817

29-
InfluxDB-Python is a client for interacting with InfluxDB_.
3018

31-
**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.**
19+
.. important::
3220

33-
Development of this library is maintained by:
21+
**This project is no longer in development**
22+
23+
This v1 client library is for interacting with `InfluxDB 1.x <https://docs.influxdata.com/influxdb/v1/>`_ and 1.x-compatible endpoints in `InfluxDB 2.x <https://docs.influxdata.com/influxdb/v2/>`_.
24+
Use it to:
25+
26+
- Write data in line protocol.
27+
- Query data with `InfluxQL <https://docs.influxdata.com/influxdb/v1/query_language/>`_.
3428

35-
+-----------+-------------------------------+
36-
| Github ID | URL |
37-
+===========+===============================+
38-
| @aviau | (https://github.com/aviau) |
39-
+-----------+-------------------------------+
40-
| @xginn8 | (https://github.com/xginn8) |
41-
+-----------+-------------------------------+
42-
| @sebito91 | (https://github.com/sebito91) |
43-
+-----------+-------------------------------+
29+
If you use `InfluxDB 2.x (TSM storage engine) <https://docs.influxdata.com/influxdb/v2/>`_ and `Flux <https://docs.influxdata.com/flux/v0/>`_, see the `v2 client library <https://github.com/influxdata/influxdb-client-python>`_.
30+
31+
If you use `InfluxDB 3.0 <https://www.influxdata.com/get-influxdb/>`_, see the `v3 client library <https://github.com/influxdata/influxdb3-python>`_.
32+
33+
For new projects, consider using InfluxDB 3.0 and v3 client libraries.
34+
35+
Description
36+
===========
37+
38+
InfluxDB-python, the InfluxDB Python Client (1.x), is a client library for interacting with `InfluxDB 1.x <https://docs.influxdata.com/influxdb/v1/>`_ instances.
4439

4540
.. _readme-about:
4641

47-
InfluxDB is an open-source distributed time series database, find more about InfluxDB_ at https://docs.influxdata.com/influxdb/latest
42+
`InfluxDB`_ is the time series platform designed to handle high write and query loads.
4843

4944

5045
.. _installation:
5146

52-
InfluxDB pre v1.1.0 users
53-
-------------------------
5447

55-
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.
48+
For InfluxDB pre-v1.1.0 users
49+
-----------------------------
5650

57-
Those users still on InfluxDB v0.8.x users may still use the legacy client by importing ``from influxdb.influxdb08 import InfluxDBClient``.
51+
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.
5852

59-
Installation
60-
------------
53+
Users on InfluxDB v0.8.x may still use the legacy client by importing ``from influxdb.influxdb08 import InfluxDBClient``.
54+
55+
For InfluxDB v1.1+ users
56+
------------------------
6157

6258
Install, upgrade and uninstall influxdb-python with these commands::
6359

@@ -165,21 +161,33 @@ We are also lurking on the following:
165161
Development
166162
-----------
167163

164+
The v1 client libraries for InfluxDB 1.x were typically developed and maintained by InfluxDB community members. If you are an InfluxDB v1 user interested in maintaining this client library (at a minimum, keeping it updated with security patches) please contact the InfluxDB team at on the `Community Forums <https://community.influxdata.com/>`_ or
165+
`InfluxData Slack <https://influxdata.com/slack>`_.
166+
168167
All development is done on Github_. Use Issues_ to report
169168
problems or submit contributions.
170169

171170
.. _Github: https://github.com/influxdb/influxdb-python/
172171
.. _Issues: https://github.com/influxdb/influxdb-python/issues
173172

174-
Please note that we WILL get to your questions/issues/concerns as quickly as possible. We maintain many
175-
software repositories and sometimes things may get pushed to the backburner. Please don't take offense,
176-
we will do our best to reply as soon as possible!
173+
Please note that we will answer you question as quickly as possible.
177174

175+
Maintainers:
176+
177+
+-----------+-------------------------------+
178+
| Github ID | URL |
179+
+===========+===============================+
180+
| @aviau | (https://github.com/aviau) |
181+
+-----------+-------------------------------+
182+
| @xginn8 | (https://github.com/xginn8) |
183+
+-----------+-------------------------------+
184+
| @sebito91 | (https://github.com/sebito91) |
185+
+-----------+-------------------------------+
178186

179187
Source code
180188
-----------
181189

182-
The source code is currently available on Github: https://github.com/influxdata/influxdb-python
190+
The source code for the InfluxDB Python Client (1.x) is currently available on Github: https://github.com/influxdata/influxdb-python
183191

184192

185193
TODO
@@ -188,6 +196,6 @@ TODO
188196
The TODO/Roadmap can be found in Github bug tracker: https://github.com/influxdata/influxdb-python/issues
189197

190198

191-
.. _InfluxDB: https://influxdata.com/time-series-platform/influxdb/
199+
.. _InfluxDB: https://influxdata.com/
192200
.. _Sphinx: http://sphinx.pocoo.org/
193201
.. _Tox: https://tox.readthedocs.org

‎docs/source/conf.py

Copy file name to clipboardExpand all lines: docs/source/conf.py
+2-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@
117117

118118
# Add any paths that contain custom themes here, relative to this directory.
119119
#html_theme_path = []
120-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
120+
# Calling get_html_theme_path is deprecated.
121+
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
121122

122123
# The name for this set of Sphinx documents. If None, it defaults to
123124
# "<project> v<release> documentation".

‎docs/source/examples.rst

Copy file name to clipboardExpand all lines: docs/source/examples.rst
+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Tutorials - UDP
3333
:language: python
3434

3535
Tutorials - Authorization by Token
36-
===============
36+
==================================
3737

3838
.. literalinclude:: ../../examples/tutorial_authorization.py
3939
:language: python

‎influxdb/client.py

Copy file name to clipboardExpand all lines: influxdb/client.py
+4-3
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ def write(self, data, params=None, expected_response_code=204,
395395
:param data: the data to be written
396396
:type data: (if protocol is 'json') dict
397397
(if protocol is 'line') sequence of line protocol strings
398-
or single string
398+
or single string
399399
:param params: additional parameters for the request, defaults to None
400400
:type params: dict
401401
:param expected_response_code: the expected response code of the write
@@ -571,8 +571,9 @@ def write_points(self,
571571
:param points: the list of points to be written in the database
572572
:type points: list of dictionaries, each dictionary represents a point
573573
:type points: (if protocol is 'json') list of dicts, where each dict
574-
represents a point.
575-
(if protocol is 'line') sequence of line protocol strings.
574+
represents a point.
575+
(if protocol is 'line') sequence of line protocol strings.
576+
576577
:param time_precision: Either 's', 'm', 'ms' or 'u', defaults to None
577578
:type time_precision: str
578579
:param database: the database to write the points to. Defaults to

‎pyproject.toml

Copy file name to clipboard
+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build-system]
2+
requires = ["setuptools>=42", "wheel"]
3+
build-backend = "setuptools.build_meta"

‎requirements.txt

Copy file name to clipboard
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
python-dateutil>=2.6.0
2-
pytz
2+
pytz>=2016.10
33
requests>=2.17.0
44
six>=1.10.0
5-
msgpack
5+
msgpack>=0.5.0

‎setup.py

Copy file name to clipboardExpand all lines: setup.py
+5
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@
2323
with open('requirements.txt', 'r') as f:
2424
requires = [x.strip() for x in f if x.strip()]
2525

26+
# Debugging: Print the requires values
27+
print("install_requires values:")
28+
for req in requires:
29+
print(f"- {req}")
30+
2631
with open('test-requirements.txt', 'r') as f:
2732
test_requires = [x.strip() for x in f if x.strip()]
2833

‎tox.ini

Copy file name to clipboardExpand all lines: tox.ini
+5-5
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ deps = -r{toxinidir}/requirements.txt
1212
py35: numpy==1.14.6
1313
py36: pandas==0.23.4
1414
py36: numpy==1.15.4
15-
py37: pandas==0.24.2
16-
py37: numpy==1.16.2
15+
py37: pandas>=0.24.2
16+
py37: numpy>=1.16.2
1717
# Only install pandas with non-pypy interpreters
1818
# Testing all combinations would be too expensive
1919
commands = nosetests -v --with-doctest {posargs}
@@ -38,9 +38,9 @@ commands = nosetests -v --with-coverage --cover-html --cover-package=influxdb
3838

3939
[testenv:docs]
4040
deps = -r{toxinidir}/requirements.txt
41-
pandas==0.24.2
42-
numpy==1.16.2
43-
Sphinx==1.8.5
41+
pandas>=0.24.2
42+
numpy>=1.16.2
43+
Sphinx>=1.8.5
4444
sphinx_rtd_theme
4545
commands = sphinx-build -b html docs/source docs/build
4646

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.