From 8f2bdbc670429afb2613de1465ca891ea0a5ace4 Mon Sep 17 00:00:00 2001 From: Belousow Makc Date: Tue, 5 Apr 2016 21:30:21 +0300 Subject: [PATCH 1/8] Start docs --- aioriak/client.py | 2 + docs/aioriak.datatypes.rst | 70 ------------------ docs/aioriak.rst | 70 ------------------ docs/aioriak.tests.rst | 54 -------------- docs/client.rst | 33 +++++++++ docs/conf.py | 146 +++++++++++++++++++------------------ docs/index.rst | 74 +++++++++++++++++-- 7 files changed, 177 insertions(+), 272 deletions(-) delete mode 100644 docs/aioriak.datatypes.rst delete mode 100644 docs/aioriak.rst delete mode 100644 docs/aioriak.tests.rst create mode 100644 docs/client.rst diff --git a/aioriak/client.py b/aioriak/client.py index d5c87a1..361a41a 100644 --- a/aioriak/client.py +++ b/aioriak/client.py @@ -338,6 +338,8 @@ async def set_bucket_props(self, bucket, props): async def get_keys(self, bucket): ''' + coroutine + Lists all keys in a bucket. .. warning:: Do not use this in production, as it requires diff --git a/docs/aioriak.datatypes.rst b/docs/aioriak.datatypes.rst deleted file mode 100644 index c4ea0df..0000000 --- a/docs/aioriak.datatypes.rst +++ /dev/null @@ -1,70 +0,0 @@ -aioriak.datatypes package -========================= - -Submodules ----------- - -aioriak.datatypes.counter module --------------------------------- - -.. automodule:: aioriak.datatypes.counter - :members: - :undoc-members: - :show-inheritance: - -aioriak.datatypes.datatype module ---------------------------------- - -.. automodule:: aioriak.datatypes.datatype - :members: - :undoc-members: - :show-inheritance: - -aioriak.datatypes.flag module ------------------------------ - -.. automodule:: aioriak.datatypes.flag - :members: - :undoc-members: - :show-inheritance: - -aioriak.datatypes.map module ----------------------------- - -.. automodule:: aioriak.datatypes.map - :members: - :undoc-members: - :show-inheritance: - -aioriak.datatypes.register module ---------------------------------- - -.. automodule:: aioriak.datatypes.register - :members: - :undoc-members: - :show-inheritance: - -aioriak.datatypes.set module ----------------------------- - -.. automodule:: aioriak.datatypes.set - :members: - :undoc-members: - :show-inheritance: - -aioriak.datatypes.types module ------------------------------- - -.. automodule:: aioriak.datatypes.types - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: aioriak.datatypes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/aioriak.rst b/docs/aioriak.rst deleted file mode 100644 index d1200ec..0000000 --- a/docs/aioriak.rst +++ /dev/null @@ -1,70 +0,0 @@ -aioriak package -=============== - -Subpackages ------------ - -.. toctree:: - - aioriak.datatypes - aioriak.tests - -Submodules ----------- - -aioriak.bucket module ---------------------- - -.. automodule:: aioriak.bucket - :members: - :undoc-members: - :show-inheritance: - -aioriak.client module ---------------------- - -.. automodule:: aioriak.client - :members: - :undoc-members: - :show-inheritance: - -aioriak.content module ----------------------- - -.. automodule:: aioriak.content - :members: - :undoc-members: - :show-inheritance: - -aioriak.error module --------------------- - -.. automodule:: aioriak.error - :members: - :undoc-members: - :show-inheritance: - -aioriak.riak_object module --------------------------- - -.. automodule:: aioriak.riak_object - :members: - :undoc-members: - :show-inheritance: - -aioriak.transport module ------------------------- - -.. automodule:: aioriak.transport - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: aioriak - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/aioriak.tests.rst b/docs/aioriak.tests.rst deleted file mode 100644 index 0e2d751..0000000 --- a/docs/aioriak.tests.rst +++ /dev/null @@ -1,54 +0,0 @@ -aioriak.tests package -===================== - -Submodules ----------- - -aioriak.tests.base module -------------------------- - -.. automodule:: aioriak.tests.base - :members: - :undoc-members: - :show-inheritance: - -aioriak.tests.test_btypes module --------------------------------- - -.. automodule:: aioriak.tests.test_btypes - :members: - :undoc-members: - :show-inheritance: - -aioriak.tests.test_client module --------------------------------- - -.. automodule:: aioriak.tests.test_client - :members: - :undoc-members: - :show-inheritance: - -aioriak.tests.test_datatypes module ------------------------------------ - -.. automodule:: aioriak.tests.test_datatypes - :members: - :undoc-members: - :show-inheritance: - -aioriak.tests.test_kv module ----------------------------- - -.. automodule:: aioriak.tests.test_kv - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: aioriak.tests - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/client.rst b/docs/client.rst new file mode 100644 index 0000000..8169569 --- /dev/null +++ b/docs/client.rst @@ -0,0 +1,33 @@ +.. highlight:: python +.. module:: aioriak.client + +==================== +Client & Connections +==================== + +To connect to a Riak cluster, you must create a +:py:class:`~aioriak.client.RiakClient` object. The default configuration +connects to a Riak node on ``localhost`` with the default +ports. The below instantiation statements are all equivalent:: + + from aioriak import RiakClient + + + client = RiakClient() + + async def go(): + client = await RiakClient.create(host='127.0.0.1', port=8087) + +.. note:: Connections are not established until you attempt to perform + an operation. If the host or port are incorrect, you will not get + an error raised immediately. + +-------------- +Client objects +-------------- + +.. currentmodule:: aioriak.client +.. autoclass:: RiakClient + + .. autoattribute:: client_id + .. autoattribute:: resolver diff --git a/docs/conf.py b/docs/conf.py index 96520bb..a92e084 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,20 +19,22 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx.ext.intersphinx', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', + 'sphinxcontrib.asyncio', ] # Add any paths that contain templates here, relative to this directory. @@ -44,7 +46,7 @@ source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -72,9 +74,9 @@ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -83,27 +85,27 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True @@ -118,26 +120,26 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. # " v documentation" by default. -#html_title = 'aioriak v' +# html_title = 'aioriak v' # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None +# the docs. This file should be a Windows icon file (.ico) being 16x16 or +# 32x32 pixels large. +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -147,64 +149,64 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not None, a 'Last updated on:' timestamp is inserted at every page # bottom, using the given strftime format. # The empty string is equivalent to '%b %d, %Y'. -#html_last_updated_fmt = None +# html_last_updated_fmt = None # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' -#html_search_language = 'en' +# html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # 'ja' uses this config value. # 'zh' user can custom change `jieba` dictionary path. -#html_search_options = {'type': 'default'} +# html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' +# html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'aioriakdoc' @@ -212,17 +214,17 @@ # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', -# Latex figure (float) alignment -#'figure_align': 'htbp', + # Latex figure (float) alignment + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples @@ -235,23 +237,23 @@ # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- @@ -264,7 +266,7 @@ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -279,16 +281,16 @@ ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False # -- Options for Epub output ---------------------------------------------- @@ -300,62 +302,64 @@ epub_copyright = copyright # The basename for the epub file. It defaults to the project name. -#epub_basename = project +# epub_basename = project # The HTML theme for the epub output. Since the default themes are not # optimized for small screen space, using the same theme for HTML and epub # output is usually not wise. This defaults to 'epub', a theme designed to save # visual space. -#epub_theme = 'epub' +# epub_theme = 'epub' # The language of the text. It defaults to the language option # or 'en' if the language is not set. -#epub_language = '' +# epub_language = '' # The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' +# epub_scheme = '' # The unique identifier of the text. This can be a ISBN number # or the project homepage. -#epub_identifier = '' +# epub_identifier = '' # A unique identification for the text. -#epub_uid = '' +# epub_uid = '' # A tuple containing the cover image and cover page html template filenames. -#epub_cover = () +# epub_cover = () # A sequence of (type, uri, title) tuples for the guide element of content.opf. -#epub_guide = () +# epub_guide = () # HTML files that should be inserted before the pages created by sphinx. # The format is a list of tuples containing the path and title. -#epub_pre_files = [] +# epub_pre_files = [] # HTML files that should be inserted after the pages created by sphinx. # The format is a list of tuples containing the path and title. -#epub_post_files = [] +# epub_post_files = [] # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] # The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 +# epub_tocdepth = 3 # Allow duplicate toc entries. -#epub_tocdup = True +# epub_tocdup = True # Choose between 'default' and 'includehidden'. -#epub_tocscope = 'default' +# epub_tocscope = 'default' # Fix unsupported image types using the Pillow. -#epub_fix_images = False +# epub_fix_images = False # Scale large images. -#epub_max_image_width = 0 +# epub_max_image_width = 0 # How to display URL addresses: 'footnote', 'no', or 'inline'. -#epub_show_urls = 'inline' +# epub_show_urls = 'inline' # If false, no index is generated. -#epub_use_index = True +# epub_use_index = True + +# Custom configs diff --git a/docs/index.rst b/docs/index.rst index da54e96..3ff5653 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,18 +1,76 @@ .. aioriak documentation master file, created by - sphinx-quickstart on Sat Apr 2 10:53:29 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. + sphinx-quickstart on Sat Apr 2 10:53:29 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. Welcome to aioriak's documentation! =================================== -Contents: +Asyncio (:pep:`3156`) Riak client library. +This library base on official Basho python client library +(https://github.com/basho/riak-python-client). -.. toctree:: - :maxdepth: 4 +Features +-------- + +================================ ============================== +Riak KV operations Yes +Riak Datatypes Yes +Riak BucketTypes Yes +Custom resolver Yes +Node list support No +Custom quorum No +Connections Pool No +Operations timout No +Security No +Riak Search No +MapReduce No +Tested python versions `3.5.0, 3.5.1 `_ +Tested Riak versions `2.1.3 `_ +================================ ============================== + +Installation +------------ + +The easiest way to install aioredis is by using the package on PyPi:: + + pip install aioriak + +Requirements +------------ + +- Python >= 3.5 +- riak>=2.3.0 - aioriak +Contribute +---------- +- Issue Tracker: https://github.com/rambler-digital-solutions/aioriak/issues +- Source Code: https://github.com/rambler-digital-solutions/aioriak + +Feel free to file an issue or make pull request if you find any bugs or have +some suggestions for library improvement. + +License +------- + +The aioredis is offered under `MIT license`_. + +---- + +Contents +======== + +.. toctree:: + :maxdepth: 4 + + client + bucket + object + datatypes + query + security + advanced Indices and tables ================== @@ -21,3 +79,5 @@ Indices and tables * :ref:`modindex` * :ref:`search` +.. _MIT license: https://raw.githubusercontent.com/rambler-digital-solutions/aioriak/master/LICENSE.txt +.. _travis: https://travis-ci.org/rambler-digital-solutions/aioriak From 1ed4374ec045ba7fd3840068287fc2d3bcc9824b Mon Sep 17 00:00:00 2001 From: Belousow Makc Date: Wed, 6 Apr 2016 13:27:21 +0300 Subject: [PATCH 2/8] Add reqyirements-dev --- requirements-dev.txt | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 requirements-dev.txt diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..05a811f --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,4 @@ +Sphinx==1.4 +sphinx-autobuild==0.6.0 +sphinx-rtd-theme==0.1.9 +sphinxcontrib-asyncio==0.1.1 From a5ae48a1799deccf4fa40dc67572c66b6f9c06c1 Mon Sep 17 00:00:00 2001 From: Belousow Makc Date: Fri, 15 Apr 2016 12:21:15 +0300 Subject: [PATCH 3/8] Cleanup old AsyncPBStream code --- aioriak/transport.py | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/aioriak/transport.py b/aioriak/transport.py index 263465d..647b607 100644 --- a/aioriak/transport.py +++ b/aioriak/transport.py @@ -22,18 +22,6 @@ async def create_transport(host='localhost', port=8087, loop=None): return conn -class AsyncPBStream: - ''' - Used internally by RiakPbcAsyncTransport to implement streaming - operations. Implements the async iterator interface. - ''' - async def __aiter__(self): - return self - - async def __anext__(self): - raise StopIteration - - class RPBPacketParser: ''' Riak protobuf packet parser.''' HEADER_LENGTH = 4 From a80dc999074c4985b66482d7654a57d65707f8d6 Mon Sep 17 00:00:00 2001 From: Belousow Makc Date: Fri, 15 Apr 2016 12:30:19 +0300 Subject: [PATCH 4/8] Update README.md add testing section --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5b03aa4..0e1f265 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,13 @@ bucket = bucket_type.bucket('example') obj = await bucket.get('key') print(obj.data) ``` + +## Testing ## + +### Docker based testing ### + +You can use docker for running: + +```bash +DOCKER_CLUSTER=1 python setup.py test +``` From 217b93501278804ef0271a6dc47514caec229391 Mon Sep 17 00:00:00 2001 From: Belousow Makc Date: Wed, 20 Apr 2016 08:13:44 +0300 Subject: [PATCH 5/8] Fix pip setup process --- MANIFEST.in | 1 + Makefile | 7 ------- setup.cfg | 3 +++ setup.py | 1 - 4 files changed, 4 insertions(+), 8 deletions(-) create mode 100644 MANIFEST.in delete mode 100644 Makefile diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..04c9665 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include commands.py diff --git a/Makefile b/Makefile deleted file mode 100644 index e597a47..0000000 --- a/Makefile +++ /dev/null @@ -1,7 +0,0 @@ -.PHONY: tests - -.DEFAULT: - cd tests/docker/ && $(MAKE) $(MAKECMDGOALS) - -tests: - @echo "run tests" diff --git a/setup.cfg b/setup.cfg index c33ff4a..31d9ab4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,3 +6,6 @@ verbosity=2 with-coverage=1 cover-package=aioriak cover-erase=1 + +[metadata] +description-file = README.md diff --git a/setup.py b/setup.py index d236f34..5d841ce 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,6 @@ description='Async implementation of Riak DB python client', author='Makc Belousov', author_email='m.belousov@rambler-co.ru', - long_description='', url='https://github.com/rambler-digital-solutions/aioriak', keywords='riak asyncio client', # package_dir={'': ''}, From 0e9474941d742e395dddec9ede353d98fbf2ca22 Mon Sep 17 00:00:00 2001 From: Belousow Makc Date: Wed, 20 Apr 2016 08:14:09 +0300 Subject: [PATCH 6/8] Update documentation --- aioriak/client.py | 2 -- docs/client.rst | 27 +++++++++++++++++++++++++-- docs/conf.py | 1 + docs/index.rst | 21 +++++++++++---------- requirements-dev.txt | 4 ++-- 5 files changed, 39 insertions(+), 16 deletions(-) diff --git a/aioriak/client.py b/aioriak/client.py index 361a41a..d5c87a1 100644 --- a/aioriak/client.py +++ b/aioriak/client.py @@ -338,8 +338,6 @@ async def set_bucket_props(self, bucket, props): async def get_keys(self, bucket): ''' - coroutine - Lists all keys in a bucket. .. warning:: Do not use this in production, as it requires diff --git a/docs/client.rst b/docs/client.rst index 8169569..248ed7a 100644 --- a/docs/client.rst +++ b/docs/client.rst @@ -1,4 +1,5 @@ .. highlight:: python + .. module:: aioriak.client ==================== @@ -29,5 +30,27 @@ Client objects .. currentmodule:: aioriak.client .. autoclass:: RiakClient - .. autoattribute:: client_id - .. autoattribute:: resolver + .. autoattribute:: resolver + +----------------------- +Client-level Operations +----------------------- + +Some operations are not scoped by buckets or bucket types and can be +performed on the client directly: + +.. autocomethod:: RiakClient.ping +.. autocomethod:: RiakClient.get_buckets + +---------------------------------- +Accessing Bucket Types and Buckets +---------------------------------- + +Most client operations are on :py:class:`bucket type objects +`, the :py:class:`bucket objects +` they contain or keys within those buckets. Use the +``bucket_type`` or ``bucket`` methods for creating bucket types and buckets +that will proxy operations to the called client. + +.. automethod:: RiakClient.bucket_type +.. automethod:: RiakClient.bucket diff --git a/docs/conf.py b/docs/conf.py index a92e084..4c87941 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,6 +20,7 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ diff --git a/docs/index.rst b/docs/index.rst index 3ff5653..438c7e9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ Welcome to aioriak's documentation! =================================== Asyncio (:pep:`3156`) Riak client library. -This library base on official Basho python client library +This project is based on official Bash python client library (https://github.com/basho/riak-python-client). Features @@ -32,7 +32,7 @@ Tested Riak versions `2.1.3 `_ Installation ------------ -The easiest way to install aioredis is by using the package on PyPi:: +The easiest way to install aioriak is by using the package on PyPi:: pip install aioriak @@ -40,7 +40,7 @@ Requirements ------------ - Python >= 3.5 -- riak>=2.3.0 +- riak>=2.1.3 Contribute ---------- @@ -54,7 +54,7 @@ some suggestions for library improvement. License ------- -The aioredis is offered under `MIT license`_. +The aioriak is offered under `MIT license`_. ---- @@ -65,12 +65,13 @@ Contents :maxdepth: 4 client - bucket - object - datatypes - query - security - advanced + +# bucket +# object +# datatypes +# query +# security +# advanced Indices and tables ================== diff --git a/requirements-dev.txt b/requirements-dev.txt index 05a811f..a2f2ad4 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,4 +1,4 @@ -Sphinx==1.4 +Sphinx==1.4.1 sphinx-autobuild==0.6.0 sphinx-rtd-theme==0.1.9 -sphinxcontrib-asyncio==0.1.1 +sphinxcontrib-asyncio==0.2.0 From b338701c5747035eadee07c6141a437d768a1e02 Mon Sep 17 00:00:00 2001 From: Belousow Makc Date: Wed, 20 Apr 2016 08:39:58 +0300 Subject: [PATCH 7/8] Bump version to 0.0.3 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 5d841ce..9175ce2 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ setup( name='aioriak', - version='0.0.2', + version='0.0.3', description='Async implementation of Riak DB python client', author='Makc Belousov', author_email='m.belousov@rambler-co.ru', From 9758ab39f5c51d9cb7e9cbd91608054e23449817 Mon Sep 17 00:00:00 2001 From: Belousow Makc Date: Wed, 20 Apr 2016 08:41:24 +0300 Subject: [PATCH 8/8] Update changelog --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cb9a762..eb2b916 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 0.0.3 (2016-04-20) + +Fix: + + - Fix pip install process + ## 0.0.2 (2016-04-01) Features: