chore: added check to code style, added check to correct PyPI documentation (#126)

Author: bednar

.circleci/config.yml

@@ -46,7 +46,7 @@ jobs:
     parameters:
       python-image:
         type: string
-        default: "circleci/python:3.6-buster"
+        default: &default-python "circleci/python:3.6-buster"
       influxdb-image:
         type: string
         default: "influxdb:2.0.0-beta"
@@ -69,24 +69,51 @@ jobs:
       - run:
           name: "Collecting coverage reports"
           command: bash <(curl -s https://codecov.io/bash) -f ./coverage.xml || echo "Codecov did not collect coverage reports"
+  check-code-style:
+    docker:
+      - image: *default-python
+        environment:
+          PIPENV_VENV_IN_PROJECT: true
+    steps:
+      - checkout
+      - run:
+          name: Checks style consistency across sources.
+          command: |
+            pip install flake8 --user
+            flake8 influxdb_client/
+  check-twine:
+    docker:
+      - image: *default-python
+        environment:
+          PIPENV_VENV_IN_PROJECT: true
+    steps:
+      - checkout
+      - run:
+          name: Checks that the description will render correctly on PyPI.
+          command: |
+            pip install twine --user
+            python setup.py sdist bdist_wheel
+            twine check dist/*
 
 workflows:
   version: 2
   build:
     jobs:
+      - check-code-style
+      - check-twine
       - tests-python:
-          name: python-3.6
+          name: test-3.6
       - tests-python:
-          name: python-3.6-without-ciso8601
+          name: test-3.6-without-ciso8601
           enabled-ciso-8601: false
       - tests-python:
-          name: python-3.6-nightly
+          name: test-3.6-influxdb-nightly
           influxdb-image: "influx:nightly"
       - tests-python:
-          name: python-3.7
+          name: test-3.7
           python-image: "circleci/python:3.7-buster"
       - tests-python:
-          name: python-3.8
+          name: test-3.8
           python-image: "circleci/python:3.8-buster"
 
   nightly:

influxdb_client/client/abstract_client.py

@@ -96,7 +96,8 @@ def from_env_properties(cls, debug=None, enable_gzip=False):
             if key.startswith("INFLUXDB_V2_TAG_"):
                 default_tags[key[16:].lower()] = value
 
-        return cls(url, token, debug=debug, timeout=int(timeout), org=org, default_tags=default_tags, enable_gzip=enable_gzip)
+        return cls(url, token, debug=debug, timeout=int(timeout), org=org, default_tags=default_tags,
+                   enable_gzip=enable_gzip)
 
     def write_api(self, write_options=WriteOptions(), point_settings=PointSettings()) -> WriteApi:
         """

influxdb_client/client/influxdb_client.py

@@ -14,7 +14,6 @@
 from rx.subject import Subject
 
 from influxdb_client import WritePrecision, WriteService
-from influxdb_client.client.abstract_client import AbstractClient
 from influxdb_client.client.write.point import Point, DEFAULT_WRITE_PRECISION, _ESCAPE_KEY
 from influxdb_client.rest import ApiException
 
@@ -119,7 +118,7 @@ def __hash__(self) -> int:
 
     def __eq__(self, o: object) -> bool:
         return isinstance(o, self.__class__) \
-               and self.bucket == o.bucket and self.org == o.org and self.precision == o.precision
+            and self.bucket == o.bucket and self.org == o.org and self.precision == o.precision
 
     def __str__(self) -> str:
         return '_BatchItemKey[bucket:\'{}\', org:\'{}\', precision:\'{}\']' \
@@ -141,7 +140,7 @@ def _body_reduce(batch_items):
     return b'\n'.join(map(lambda batch_item: batch_item.data, batch_items))
 
 
-class WriteApi(AbstractClient):
+class WriteApi:
 
     def __init__(self, influxdb_client, write_options: WriteOptions = WriteOptions(),
                  point_settings: PointSettings = PointSettings()) -> None:
@@ -188,9 +187,12 @@ def write(self, bucket: str, org: str = None,
         """
         Writes time-series data into influxdb.
 
-        :param str org: specifies the destination organization for writes; take either the ID or Name interchangeably; if both orgID and org are specified, org takes precedence. (required)
+        :param str org: specifies the destination organization for writes; take either the ID or Name interchangeably;
+                        if both orgID and org are specified, org takes precedence. (required)
         :param str bucket: specifies the destination bucket for writes (required)
-        :param WritePrecision write_precision: specifies the precision for the unix timestamps within the body line-protocol. The precision specified on a Point has precedes and is use for write.
+        :param WritePrecision write_precision: specifies the precision for the unix timestamps within
+                                               the body line-protocol. The precision specified on a Point has precedes
+                                               and is use for write.
         :param record: Points, line protocol, Pandas DataFrame, RxPY Observable to write
         :param data_frame_measurement_name: name of measurement for writing Pandas DataFrame
         :param data_frame_tag_columns: list of DataFrame columns which are tags, rest columns will be fields
@@ -253,7 +255,8 @@ def _serialize(self, record, write_precision, payload, **kwargs):
             self._serialize(record.to_line_protocol(), record.write_precision, payload, **kwargs)
 
         elif isinstance(record, dict):
-            self._serialize(Point.from_dict(record, write_precision=write_precision), write_precision, payload, **kwargs)
+            self._serialize(Point.from_dict(record, write_precision=write_precision),
+                            write_precision, payload, **kwargs)
         elif 'DataFrame' in type(record).__name__:
             _data = self._data_frame_to_list_of_points(record, precision=write_precision, **kwargs)
             self._serialize(_data, write_precision, payload, **kwargs)

influxdb_client/client/write_api.py

@@ -63,7 +63,7 @@ class Authorization(AuthorizationUpdateRequest):
 
     def __init__(self, created_at=None, updated_at=None, org_id=None, permissions=None, id=None, token=None, user_id=None, user=None, org=None, links=None, status='active', description=None):  # noqa: E501
         """Authorization - a model defined in OpenAPI"""  # noqa: E501
-        AuthorizationUpdateRequest.__init__(self, status=status, description=description)
+        AuthorizationUpdateRequest.__init__(self, status=status, description=description)  # noqa: E501
 
         self._created_at = None
         self._updated_at = None

influxdb_client/domain/authorization.py

@@ -69,7 +69,7 @@ class Check(CheckBase):
 
     def __init__(self, id=None, name=None, org_id=None, owner_id=None, created_at=None, updated_at=None, query=None, status=None, every=None, offset=None, tags=None, description=None, status_message_template=None, labels=None, links=None):  # noqa: E501
         """Check - a model defined in OpenAPI"""  # noqa: E501
-        CheckBase.__init__(self, id=id, name=name, org_id=org_id, owner_id=owner_id, created_at=created_at, updated_at=updated_at, query=query, status=status, every=every, offset=offset, tags=tags, description=description, status_message_template=status_message_template, labels=labels, links=links)
+        CheckBase.__init__(self, id=id, name=name, org_id=org_id, owner_id=owner_id, created_at=created_at, updated_at=updated_at, query=query, status=status, every=every, offset=offset, tags=tags, description=description, status_message_template=status_message_template, labels=labels, links=links)  # noqa: E501
         self.discriminator = None
 
     def to_dict(self):

influxdb_client/domain/check.py

@@ -69,7 +69,7 @@ class CheckBase(CheckDiscriminator):
 
     def __init__(self, id=None, name=None, org_id=None, owner_id=None, created_at=None, updated_at=None, query=None, status=None, every=None, offset=None, tags=None, description=None, status_message_template=None, labels=None, links=None):  # noqa: E501
         """CheckBase - a model defined in OpenAPI"""  # noqa: E501
-        CheckDiscriminator.__init__(self)
+        CheckDiscriminator.__init__(self)  # noqa: E501
 
         self._id = None
         self._name = None

influxdb_client/domain/check_base.py

@@ -46,7 +46,7 @@ class CheckDiscriminator(PostCheck):
 
     def __init__(self):  # noqa: E501
         """CheckDiscriminator - a model defined in OpenAPI"""  # noqa: E501
-        PostCheck.__init__(self)
+        PostCheck.__init__(self)  # noqa: E501
         self.discriminator = 'type'
 
     def get_real_child_model(self, data):

influxdb_client/domain/check_discriminator.py

@@ -51,7 +51,7 @@ class CheckViewProperties(ViewProperties):
 
     def __init__(self, type=None, shape=None, check_id=None, check=None, queries=None, colors=None):  # noqa: E501
         """CheckViewProperties - a model defined in OpenAPI"""  # noqa: E501
-        ViewProperties.__init__(self)
+        ViewProperties.__init__(self)  # noqa: E501
 
         self._type = None
         self._shape = None

influxdb_client/domain/check_view_properties.py

@@ -55,7 +55,7 @@ class Dashboard(CreateDashboardRequest):
 
     def __init__(self, links=None, id=None, meta=None, cells=None, labels=None, org_id=None, name=None, description=None):  # noqa: E501
         """Dashboard - a model defined in OpenAPI"""  # noqa: E501
-        CreateDashboardRequest.__init__(self, org_id=org_id, name=name, description=description)
+        CreateDashboardRequest.__init__(self, org_id=org_id, name=name, description=description)  # noqa: E501
 
         self._links = None
         self._id = None