isogeo_pysdk.api.routes_link module

Isogeo API v1 - API Routes to manage metadata links.

See: http://help.isogeo.com/api/complete/index.html

class isogeo_pysdk.api.routes_link.ApiLink(api_client=None)

Bases: object

Routes as methods of Isogeo API used to manipulate metadata links (CGUs).

clean_kind_action_liability(link_actions: list, link_kind: str) → list

Link available actions depend on link kind. Relationships between kinds and actions are described in the /link-kinds route.

This is a helper checking the liability between kind/actions/type and cleaning if needed. Useful before creating or updating a link.

Parameters:

• link_actions (list) – link actions
• link_kind (str) – link kind

Return type:

list

create(metadata: isogeo_pysdk.models.metadata.Metadata, link: isogeo_pysdk.models.link.Link) → isogeo_pysdk.models.link.Link

Add a new link to a metadata (= resource).

Parameters:

• metadata (Metadata) – metadata (resource) to edit
• link (Link) – link object to create

Returns:

the created link or a tuple with the request’s response error code

Return type:

Link or tuple

Example:

# retrieve metadata
md = isogeo.metadata.get(METADATA_UUID)
# create the link locally
new_link = Link(
    type="url",
    restriction="patent",
    description="Do not use for commercial purpose.",
    )
# add it to the metadata
isogeo.metadata.links.create(md, new_link)

# to create a link which is a pointer to another link, add the link attribute:
new_link = Link(
    actions=["other"],
    title="Associated link",
    kind="url",
    type="link",
    link=Link(_id=LINK_UUID)
    )

delete(link: isogeo_pysdk.models.link.Link, metadata: isogeo_pysdk.models.metadata.Metadata = None) → requests.models.Response

Delete a link from a metadata.

Parameters:

• link (Link) – Link model object to delete
• metadata (Metadata) – parent metadata (resource) containing the link. Optional if the link contains the ‘parent_resource’ attribute.

Return type:

Response

download_hosted(link: isogeo_pysdk.models.link.Link, encode_clean: bool = 1) → tuple

Download hosted resource.

Parameters:

• link (Link) – link object
• encode_clean (bool) – option to ensure a clean filename and avoid OS errors

Returns:

tuple(stream, filename, human readable size)

Return type:

tuple

Example:

# get links from a metadata
md_links = isogeo.metadata.links.listing(Metadata(_id=METADATA_UUID))
# filter on hosted links
hosted_links = [
    link for link in md_links
    if link.get("type") == "hosted"
    ]
# get the stream, the filename and the size (in human readable format)
dl_stream = isogeo.metadata.links.download_hosted(Link(**hosted_links[0]))
# download the file and store it locally
with open("./" + dl_stream[1], "wb") as fd:
    for block in dl_stream[0].iter_content(1024):
        fd.write(block)

get(metadata_id: str, link_id: str) → isogeo_pysdk.models.link.Link

Get details about a specific link.

Parameters:

• metadata_id (str) – metadata UUID
• link_id (str) – link UUID

Return type:

Link

Example:

# get a metadata
md = isogeo.metadata.get(METADATA_UUID)
# list its links
md_links = isogeo.metadata.links.listing(md)
# get the first link
link = isogeo.metadata.links.get(
    metadata_id=md._id,
    link_id=md_links[0].get("_id")
    )

kinds_actions(caching: bool = 1) → list

Get the relation between kinds and action for links.

Parameters:caching (bool) – cache the response into the main API client instance. Defaults to True. Return type:list

listing(metadata: isogeo_pysdk.models.metadata.Metadata) → list

Get links of a metadata.

Parameters:metadata (Metadata) – metadata (resource)

update(link: isogeo_pysdk.models.link.Link, metadata: isogeo_pysdk.models.metadata.Metadata = None) → isogeo_pysdk.models.link.Link

Update a link.

Parameters:

• link (Link) – Link model object to update
• metadata (Metadata) – parent metadata (resource) containing the link. Optional if the link contains the ‘parent_resource’ attribute.

upload_hosted(metadata: isogeo_pysdk.models.metadata.Metadata, link: isogeo_pysdk.models.link.Link, file_to_upload: str) → isogeo_pysdk.models.link.Link

Add a new link to a metadata uploading a file to hosted data. See: https://requests.readthedocs.io/en/latest/user/quickstart/#post-a-multipart-encoded-file

Parameters:

• metadata (Metadata) – metadata (resource) to edit
• link (Link) – link object to create
• file_to_upload (Path) – file path to upload

Returns:

the new Link if successed or the tuple with the request error code

Return type:

Link or tuple

Example:

from pathlib import Path

# define metadata
md = isogeo.metadata.get(METADATA_UUID)

# localize the file on the OS
my_file = Path("./upload/documentation.zip")

# create the link locally
lk = Link(
    title=my_file.name
    )

# add it to the metadata
send = isogeo.metadata.links.upload_hosted(
    metadata=md,
    link=lk,
    file_to_upload=my_file.resolve()
    )