https://github.com/datadotworld/target-datadotworld

Singer.io target for data.world
https://github.com/datadotworld/target-datadotworld

dwstruct-t50-public-projects reference-implementation singer singer-io singer-target target

Last synced: about 2 months ago
JSON representation

Singer.io target for data.world

• Host: GitHub
• URL: https://github.com/datadotworld/target-datadotworld
• Owner: datadotworld
• License: apache-2.0
• Created: 2017-08-07T14:22:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-12-03T08:40:03.000Z (over 1 year ago)
• Last Synced: 2025-05-08T21:14:25.086Z (about 2 months ago)
• Topics: dwstruct-t50-public-projects, reference-implementation, singer, singer-io, singer-target, target
• Language: Python
• Homepage: https://data.world
• Size: 51.8 KB
• Stars: 5
• Watchers: 39
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
===================

target-datadotworld

===================

A `Singer `_ target that writes data to `data.world `_

How to use it

=============

``target-datadotworld`` works together with any other `Singer Tap `_ to store on data.world

data extracted from sources like `SalesForce `_, `HubSpot `_, `Marketo `_, `MySQL `_  and `more `_.

Install and Run

---------------

First, make sure Python 3.6 is installed on your system.

``target-datadotworld`` can be run with any Singer Tap, but we'll use

`tap-fixerio `_ which pulls currency exchange rate data - as an example.

These commands will install ``tap-fixerio`` and ``target-datadotworld`` with pip,

and then run them together, piping the output of ``tap-fixerio`` to

``target-datadotworld``::

  ? pip install target-datadotworld tap-fixerio 

  ? tap-fixerio | target-datadotworld -c config.json

  INFO Replicating the latest exchange rate data from fixer.io

  INFO Tap exiting normally

The data will be written to the dataset specified in ``config.json``. In this specific case, under a stream named ``exchange-rates``.

If you're using a different Tap, substitute ``tap-fixerio`` in the final

command above with the command used to run your Tap.

Configuration

-------------

`target-datadotworld` requires configuration file that is used to store your data.world API token and dataset information.

The following attributes are required:

* ``api_token``: Your data.world `API token `_

* ``dataset_id``: The title of the dataset where the data is to be stored. Must only contain lowercase letters, numbers, and dashes.

Additionally, the following optional attributes can be provided.

* ``dataset_owner``: If not the same as the owner of the API token (e.g. if the dataset is to be accessed/created under an organization account, as opposed to the user's own)

Example:

.. code-block:: json

    {

        "api_token": "your_token",

        "dataset_id": "fixerio-data",

        "dataset_owner": "my-company",

    }