Welcome to pyLinkwarden’s documentation!

Contents:

• pyLinkwarden
  • pyLinkwarden package

Modules

class pyLinkwarden.utils.http.Helper(endpoint, params=None, headers=None)

Bases: object

HTTP client to make API calls to Linkwarden

_delete(path, params=None, headers=None, data=None)

Call DELETE against a URL

_get(path, params=None, headers=None)

Call GET against a URL

_head(path, params=None, headers=None)

Call HEAD against a URL

_merge_dicts(base_dict, additional_dict)

Merges two dictionaries, giving precedence to the additional_dict.

_options(path, params=None, headers=None)

Call OPTIONS against a URL

_patch(path, data=None, params=None, headers=None)

Call PATCH against a URL

_post(path, data=None, params=None, headers=None)

Call POST against a URL

_put(path, data=None, params=None, headers=None)

Call PUT against a URL

_request(method, path, params=None, headers=None, data=None, **kwargs)

General method to handle HTTP requests

class pyLinkwarden.api.Client(endpoint, access_token=None)

Bases: object

Interacts with Linkwarden’s API

class pyLinkwarden.content.Collections(client)

Bases: object

_get()

Returns JSON of collections endpoint response.

Returns:

JSON of link data

_get_raw()

Returns entirety of collections endpoint response.

Returns:

Requests library response object

delete(collection_id)

Deletes a collection

Parameters:

collection_id – Id of collection you wish to delete

Returns:

Requests library response object

list()

Returns list of collections

Returns:

List of collections

class pyLinkwarden.content.Links(client)

Bases: object

_get(link_id=None, specific_attribute=None)

Returns JSON of links endpoint response. Returns all links if link_id is not specified. Otherwise, returns the specific link.

Parameters:

• link_id – Id of the link that you wish to view. Optional.

• specific_attribute – Returns the value of this attribute. Optional.

Returns:

JSON of link data or the specific attribute’s value.

_get_raw(link_id=None)

Returns entirety of links endpoint response. Returns all links if link_id not specified. Otherwise, returns specific link.

Parameters:

link_id – Id of link that you wish to view. Optional.

Returns:

Requests library response object

check_if_url_exists(url)

Checks to see if the provided URL already exists.

Parameters:

url – URL of page

Returns:

True if page exists, False if page does not exist.

delete(link_id)

Deletes a link

Parameters:

link_id – Id of link you wish to delete

Returns:

Requests library response object

list()

Returns list of links

Returns:

List of titles of links.

list_all_urls()

Lists all URLs in Linkwarden.

Returns:

List of URLs

class pyLinkwarden.content.Tags(client)

Bases: object

_get()

Returns JSON of tags endpoint response.

Returns:

JSON of link data

_get_raw()

Returns entirety of tags endpoint response.

Returns:

Requests library response object

delete(tag_id)

Deletes a tag

Parameters:

tag_id – Id of tag you wish to delete

Returns:

Requests library response object

list()

Returns list of tags

Returns:

List of tags

rename(tag_id, new_name)

Renames a tag

Parameters:

• tag_id – Id of tag you wish to rename

• new_name – New name for tag to be renamed to

Returns:

Requests library response object

Indices and tables

• Index

• Module Index

• Search Page