Skip to content
This repository was archived by the owner on Oct 29, 2024. It is now read-only.
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 47 additions & 24 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@


InfluxDB-Python is a client for interacting with InfluxDB_. Maintained by @aviau (https://github.com/aviau).

**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.
InfluxDB-Python
===============

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



InfluxDB-Python is a client for interacting with InfluxDB_. Development of this library is maintained by

+-----------+-------------------------------+
| Github ID | URL |
+===========+===============================+
| @aviau | (https://github.com/aviau) |
+-----------+-------------------------------+
| @xginn8 | (https://github.com/xginn8) |
+-----------+-------------------------------+
| @sebito91 | (https://github.com/sebito91) |
+-----------+-------------------------------+

.. _readme-about:

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


.. _installation:

InfluxDB pre v1.1.0 users
=========================
-------------------------

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
yet supported.

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

Installation
============
------------

Install, upgrade and uninstall InfluxDB-Python with these commands::
Install, upgrade and uninstall influxdb-python with these commands::

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

Dependencies
============
------------

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

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

Expand All @@ -61,9 +75,9 @@ Additional dependencies are:


Documentation
=============
-------------

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

You will need Sphinx_ installed to generate the documentation.

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


Examples
========
--------

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

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


Testing
=======
-------

Make sure you have tox by running the following::

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


Support
=======
-------

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

We are also lurking on the following:

- #influxdb on irc.freenode.net
- #influxdb on gophers.slack.com


Development
===========
-----------

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

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


TODO
====

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


Source code
===========
-----------

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


TODO
----

The TODO/Roadmap can be found in Github bug tracker: https://github.com/influxdata/influxdb-python/issues


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