def create_dataset(self, owner_id, **kwargs):
"""Create a new dataset
Parameters
----------
owner_id : str
Username of the owner of the new dataset
title : str
Dataset title (will be used to generate dataset id on creation)
description : str, optional
Dataset description
summary : str, optional
Dataset summary markdown
tags : list, optional
Dataset tags
license : {'Public Domain', 'PDDL', 'CC-0', 'CC-BY', 'ODC-BY',
'CC-BY-SA', 'ODC-ODbL', 'CC BY-NC', 'CC BY-NC-SA', 'Other'}
Dataset license
visibility : {'OPEN', 'PRIVATE'}
Dataset visibility
files : dict, optional
File names and source URLs
Returns
-------
str
Newly created dataset key
Raises
------
RestApiException
If a server error occurs
Examples
--------
>>> import datadotworld as dw
>>> api_client = dw.api_client()
>>> api_client.create_dataset(
... 'username', title='Test dataset', visibility='PRIVATE',
... license='Public Domain') # doctest: +SKIP
"""
request = self.__build_dataset_obj(
lambda: _swagger.DatasetCreateRequest(),
lambda name, url: _swagger.FileCreateRequest(
name=name, source=_swagger.FileSourceCreateRequest(url=url)),
kwargs)
try:
(_, _, headers) = self._datasets_api.create_dataset_with_http_info(
owner_id, request, _return_http_data_only=False)
if 'Location' in headers:
return headers['Location']
except _swagger.rest.ApiException as e:
raise RestApiError(cause=e)
def replace_dataset(self, dataset_key, **kwargs):
"""Replace an existing dataset
*This method will completely overwrite an existing dataset.*
Parameters
----------
description : str, optional
Dataset description
summary : str, optional
Dataset summary markdown
tags : list, optional
Dataset tags
license : {'Public Domain', 'PDDL', 'CC-0', 'CC-BY', 'ODC-BY',
'CC-BY-SA', 'ODC-ODbL', 'CC BY-NC', 'CC BY-NC-SA', 'Other'}
Dataset license
visibility : {'OPEN', 'PRIVATE'}
Dataset visibility
files : dict, optional
File names and source URLs to add or update
Raises
------
RestApiException
If a server error occurs
Examples
--------
>>> import datadotworld as dw
>>> api_client = dw.api_client()
>>> api_client.replace_dataset(
... 'username/test-dataset',
... visibility='PRIVATE', license='Public Domain',
... description='A better description') # doctest: +SKIP
"""
request = self.__build_dataset_obj(
lambda: _swagger.DatasetPutRequest(),
lambda name, url: _swagger.FileCreateRequest(
name=name, source=_swagger.FileSourceCreateRequest(url=url)),
kwargs)
owner_id, dataset_id = parse_dataset_key(dataset_key)
try:
self._datasets_api.replace_dataset(owner_id, dataset_id, request)
except _swagger.rest.ApiException as e:
raise RestApiError(cause=e)