Merge pull request #17 from mchwalisz/develop

v1.0.0 release

.gitignore

@@ -1,16 +1,128 @@
-# general things to ignore
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
 build/
-_build/
+develop-eggs/
 dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
 *.egg-info/
+.installed.cfg
 *.egg
-*.py[cod]
-__pycache__/
-*.so
-*~
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
 
-# due to using tox and pytest
-.tox
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
 .cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+### Python Patch ###
+.venv/
+
+# End of https://www.gitignore.io/api/python
 
-thingspeak/__version__.py
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+-   repo: https://github.com/ambv/black
+    rev: stable
+    hooks:
+    - id: black
+      language_version: python3.7

.readthedocs.yml

@@ -0,0 +1,6 @@
+build:
+  image: latest
+
+python:
+  version: 3.6
+  pip_install: true

.travis.yml

@@ -1,8 +1,23 @@
 language: python
-python:
-  - "2.7"
-  - "3.4"
-  - "3.5"
-  - "3.6"
-install: pip install -e .
-script: python setup.py test
+matrix:
+  include:
+    - python: 3.4
+    - python: 3.5
+    - python: 3.6
+    - python: 3.7
+      dist: xenial
+      sudo: true
+
+cache:
+  pip: true
+  directories:
+    - $HOME/.cache/pypoetry
+
+install:
+  - pip install pip -U
+  - curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
+  - source $HOME/.poetry/env
+  - poetry install -v
+  - poetry build -v
+
+script: poetry run pytest --vcr-record none

CONTRIBUTORS

@@ -1,2 +1,3 @@
 Mikołaj Chwalisz  - Originator
 Keith Ellis
+Yusuke Mitsuki

README.rst

@@ -1,12 +1,18 @@
 Client library for the thingspeak.com API
 =========================================
 
-.. image:: https://travis-ci.org/mchwalisz/thingspeak.svg?branch=master
+|saythanks| master: |masterbadge| develop: |developbadge|
+
+.. |masterbadge| image:: https://travis-ci.org/mchwalisz/thingspeak.svg?branch=master
     :target: https://travis-ci.org/mchwalisz/thingspeak
-.. image:: https://travis-ci.org/mchwalisz/thingspeak.svg?branch=develop
+
+.. |developbadge| image:: https://travis-ci.org/mchwalisz/thingspeak.svg?branch=develop
     :target: https://travis-ci.org/mchwalisz/thingspeak
-    :alt: travis develop
-
+
+.. |saythanks| image:: https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg
+    :target: https://saythanks.io/to/mchwalisz
+    :alt: Say thanks!
+
 ThingSpeak is an open source “Internet of Things” application and API to store and retrieve data from things using HTTP over the Internet or via a Local Area Network. With ThingSpeak, you can create sensor logging applications, location tracking applications, and a social network of things with status updates. https://thingspeak.com https://github.com/iobridge/ThingSpeak
 
 This repository is contains Python module that helps in talking to ThingSpeak API.

docs/changelog.rst

@@ -0,0 +1,34 @@
+Changelog
+=========
+
+`v1.0.0 <https://github.com/mchwalisz/thingspeak/releases/tag/v1.0.0>`_
+-----------------------------------------------------------------------
+
+.. warning::
+
+   - `read_key` and `write_key` have been replaced with `api_key`
+
+     The user needs to decide which key should be used. The change is inline with thingspeak API design.
+
+- Upated examples
+- Added tests, using `vcrpy <https://vcrpy.readthedocs.io/en/latest/index.html>`_ to store http responses.
+- Switched to use `poetry <https://poetry.eustace.io/>`_ for deployment and requirements management
+
+
+`v0.4.0 <https://github.com/mchwalisz/thingspeak/releases/tag/v0.4.0>`_
+-----------------------------------------------------------------------
+
+- Added `thingspeak.get_field()`
+- Added examples
+- Added timeout option
+
+
+`v0.3.6 <https://github.com/mchwalisz/thingspeak/releases/tag/v0.3.6>`_
+-----------------------------------------------------------------------
+
+- First releases
+
+`v0.1.1 <https://github.com/bergey/thingspeak>`_
+------------------------------------------------
+
+- Original version of thingspeak library from @bergey

docs/conf.py

@@ -1,69 +1,75 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+import pkg_resources
 import thingspeak
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
 ]
 
-project = 'thingspeak'
-source_suffix = '.rst'
-master_doc = 'index'
-copyright = '2016, Mikołaj Chwalisz'
-author = 'Mikołaj Chwalisz'
+project = "thingspeak"
+source_suffix = ".rst"
+master_doc = "index"
+copyright = "2016-2019, Mikołaj Chwalisz"
+author = "Mikołaj Chwalisz"
 
-version = thingspeak.__version__
-release = thingspeak.__version__
+version = pkg_resources.get_distribution("thingspeak").version
+release = pkg_resources.get_distribution("thingspeak").version
 
 language = None
 
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-pygments_style = 'sphinx'
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+pygments_style = "sphinx"
 todo_include_todos = True
 
-templates_path = ['_templates']
-html_static_path = ['_static']
-html_theme = 'alabaster'
+templates_path = ["_templates"]
+html_static_path = ["_static"]
+html_theme = "alabaster"
 html_theme_options = {
-    'logo_name': True,
-    'description': 'Python binding for ThingSpeak API',
-    'github_user': 'mchwalisz',
-    'github_repo': 'thingspeak',
-    'github_banner': True,
-    'github_button': True,
-    'extra_nav_links': {'ThingSpeak': "https://thingspeak.com/"},
-    'analytics_id': 'UA-47922208-4',
+    "logo_name": True,
+    "description": "Python binding for ThingSpeak API",
+    "github_user": "mchwalisz",
+    "github_repo": "thingspeak",
+    "github_banner": True,
+    "github_button": True,
+    "extra_nav_links": {
+        "ThingSpeak.com": "https://thingspeak.com/",
+        "Say Thanks!": "https://saythanks.io/to/mchwalisz",
+    },
+    "analytics_id": "UA-47922208-4",
 }
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'relations.html',
-        'searchbox.html',
-    ]
+    "**": ["about.html", "navigation.html", "relations.html", "searchbox.html"]
 }
-htmlhelp_basename = 'thingspeakdoc'
+htmlhelp_basename = "thingspeakdoc"
 
-latex_elements = {
-}
+latex_elements = {}
 latex_documents = [
-    (master_doc, 'thingspeak.tex', 'thingspeak Documentation',
-     'Mikołaj Chwalisz', 'manual'),
+    (
+        master_doc,
+        "thingspeak.tex",
+        "thingspeak Documentation",
+        "Mikołaj Chwalisz",
+        "manual",
+    )
 ]
 texinfo_documents = [
-    (master_doc, 'thingspeak', 'thingspeak Documentation',
-     author, 'thingspeak', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "thingspeak",
+        "thingspeak Documentation",
+        author,
+        "thingspeak",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
-man_pages = [
-    (master_doc, 'thingspeak', 'thingspeak Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "thingspeak", "thingspeak Documentation", [author], 1)]
 
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}

docs/index.rst

@@ -5,6 +5,17 @@ Python binding for ThingSpeak API
 
 This repository is contains Python module that helps in talking to ThingSpeak API.
 
+|saythanks| master: |masterbadge| develop: |developbadge|
+
+.. |masterbadge| image:: https://travis-ci.org/mchwalisz/thingspeak.svg?branch=master
+    :target: https://travis-ci.org/mchwalisz/thingspeak
+
+.. |developbadge| image:: https://travis-ci.org/mchwalisz/thingspeak.svg?branch=develop
+    :target: https://travis-ci.org/mchwalisz/thingspeak
+
+.. |saythanks| image:: https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg
+    :target: https://saythanks.io/to/mchwalisz
+    :alt: Say thanks!
 
 .. rubric:: Contents
 
@@ -13,6 +24,7 @@ This repository is contains Python module that helps in talking to ThingSpeak AP
 
    install
    examples
+   changelog
    api
 
 .. warning::