Skip to content

Commit c9a1b86

Browse files
committed
updating README
1 parent df6e2fe commit c9a1b86

File tree

1 file changed

+47
-24
lines changed

1 file changed

+47
-24
lines changed

README.rst

Lines changed: 47 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
2-
3-
InfluxDB-Python is a client for interacting with InfluxDB_. Maintained by @aviau (https://github.com/aviau).
4-
5-
**Help needed:** Development of this library is made by the community and help is needed. A co-maintainer would be welcome. To contribute, take a look at the issues list of simply contact @aviau.
1+
InfluxDB-Python
2+
===============
63

74
.. image:: https://travis-ci.org/influxdata/influxdb-python.svg?branch=master
85
:target: https://travis-ci.org/influxdata/influxdb-python
@@ -15,22 +12,39 @@ InfluxDB-Python is a client for interacting with InfluxDB_. Maintained by @aviau
1512
:target: https://coveralls.io/r/influxdata/influxdb-python
1613
:alt: Coverage
1714

15+
16+
17+
InfluxDB-Python is a client for interacting with InfluxDB_. Development of this library is maintained by
18+
19+
+-----------+-------------------------------+
20+
| Github ID | URL |
21+
+===========+===============================+
22+
| @aviau | (https://github.com/aviau) |
23+
+-----------+-------------------------------+
24+
| @xginn8 | (https://github.com/xginn8) |
25+
+-----------+-------------------------------+
26+
| @sebito91 | (https://github.com/sebito91) |
27+
+-----------+-------------------------------+
28+
1829
.. _readme-about:
1930

20-
InfluxDB is an open-source distributed time series database, find more about InfluxDB_ at http://influxdata.com/
31+
InfluxDB is an open-source distributed time series database, find more about InfluxDB_ at https://docs.influxdata.com/influxdb/latest
2132

2233

2334
.. _installation:
2435

2536
InfluxDB pre v1.1.0 users
26-
=========================
37+
-------------------------
38+
39+
This module is tested with InfluxDB v1.2.4, our recommended version. Though there have been v1.3 (initial TSI branch) and v1.4 releases these are not
40+
yet supported.
2741

28-
InfluxDB 1.1.0 was released and it is the new recommended version. InfluxDB 0.8.x users may still use the legacy client by using ``from influxdb.influxdb08 import InfluxDBClient`` instead.
42+
Those users still on InfluxDB v0.8.x users may still use the legacy client by importing ``from influxdb.influxdb08 import InfluxDBClient``.
2943

3044
Installation
31-
============
45+
------------
3246

33-
Install, upgrade and uninstall InfluxDB-Python with these commands::
47+
Install, upgrade and uninstall influxdb-python with these commands::
3448

3549
$ pip install influxdb
3650
$ pip install --upgrade influxdb
@@ -41,9 +55,9 @@ On Debian/Ubuntu, you can install it with this command::
4155
$ sudo apt-get install python-influxdb
4256

4357
Dependencies
44-
============
58+
------------
4559

46-
The InfluxDB-Python distribution is supported and tested on Python 2.7, 3.3, 3.4, 3.5, 3.6, PyPy and PyPy3.
60+
The influxdb-python distribution is supported and tested on Python 2.7, 3.3, 3.4, 3.5, 3.6, PyPy and PyPy3.
4761

4862
**Note:** Python 3.2 is currently untested. See ``.travis.yml``.
4963

@@ -61,9 +75,9 @@ Additional dependencies are:
6175

6276

6377
Documentation
64-
=============
78+
-------------
6579

66-
InfluxDB-Python documentation is available at http://influxdb-python.readthedocs.org
80+
Documentation is available at https://influxdb-python.readthedocs.io/en/latest/.
6781

6882
You will need Sphinx_ installed to generate the documentation.
6983

@@ -76,7 +90,7 @@ Generated documentation can be found in the *docs/build/html/* directory.
7690

7791

7892
Examples
79-
========
93+
--------
8094

8195
Here's a basic example (for more see the examples directory)::
8296

@@ -110,7 +124,7 @@ Here's a basic example (for more see the examples directory)::
110124

111125

112126
Testing
113-
=======
127+
-------
114128

115129
Make sure you have tox by running the following::
116130

@@ -122,34 +136,43 @@ To test influxdb-python with multiple version of Python, you can use Tox_::
122136

123137

124138
Support
125-
=======
139+
-------
126140

127141
For issues with, questions about, or feedback for InfluxDB_, please look into
128142
our community page: http://influxdb.com/community/.
129143

144+
We are also lurking on the following:
145+
146+
- #influxdb on irc.freenode.net
147+
- #influxdb on gophers.slack.com
148+
130149

131150
Development
132-
===========
151+
-----------
133152

134153
All development is done on Github_. Use Issues_ to report
135154
problems or submit contributions.
136155

137156
.. _Github: https://github.com/influxdb/influxdb-python/
138157
.. _Issues: https://github.com/influxdb/influxdb-python/issues
139158

140-
141-
TODO
142-
====
143-
144-
The TODO/Roadmap can be found in Github bug tracker: https://github.com/influxdata/influxdb-python/issues
159+
Please note that we WILL get to your questions/issues/concerns as quickly as possible. We maintain many
160+
software repositories and sometimes things may get pushed to the backburner. Please don't take offense,
161+
we will do our best to reply as soon as possible!
145162

146163

147164
Source code
148-
===========
165+
-----------
149166

150167
The source code is currently available on Github: https://github.com/influxdata/influxdb-python
151168

152169

170+
TODO
171+
----
172+
173+
The TODO/Roadmap can be found in Github bug tracker: https://github.com/influxdata/influxdb-python/issues
174+
175+
153176
.. _InfluxDB: https://influxdata.com/time-series-platform/influxdb/
154177
.. _Sphinx: http://sphinx.pocoo.org/
155178
.. _Tox: https://tox.readthedocs.org

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy