Skip to content

Update README.rst #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brettandersonddw wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.rst #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,12 +283,12 @@ Additional API Features
For a complete list of available API operations, see
`official documentation <https://docs.data.world/documentation/api/>`_.

Python wrappers are implemented by the ``ApiClient`` class. To obtain an instance, simply call ``api_client``.
Python wrappers are implemented by the ``ApiClient`` class. To obtain an instance, simply call ``api_client()``.
For example:

.. code-block:: python

client = dw.api_client
client = dw.api_client()

The client currently implements the following functions:

Expand Down Expand Up @@ -338,7 +338,7 @@ For example:

.. code-block:: python

>>> client = dw.api_client
>>> client = dw.api_client()
>>> client.add_files_via_url('username/test-dataset', files={'sample.xls': {'url':'http://www.sample.com/sample.xls', 'description': 'sample doc', 'labels': ['raw data']}})

Append records to stream
Expand All @@ -350,7 +350,7 @@ For example:

.. code-block:: python

>>> client = dw.api_client
>>> client = dw.api_client()
>>> client.append_records('username/test-dataset','streamId', {'data': 'data'})

Contents of a stream will appear as part of the respective dataset as a .jsonl file.
Expand Down