/pyLinkwarden

A Python library and script archive for interacting with Linkwarden

Primary LanguagePython

pyLinkwarden

A Python library and script archive for interacting with Linkwarden.

Linkwarden is a self-hosted collaborative bookmark manager to collect, organize, and preserve webpages and articles. Find out more about it on their official website or their official GitHub repo.

This repository contains a Python library that can be used to interact with Linkwarden. It also includes useful, pre-made scripts that are ready-to-go.

Installation

pip install pyLinkwarden

Documentation

Full documentation can be found here.

Capabilities

This library is a work in progress and will continue to gain new functionality. Here is what you can expect from the current release:

Ability
Get List Create Rename Delete
Collections
Links
Tags

Example Usage

Please refer to the full documentation here or see quick examples below.

Importing the Module & Connecting to Linkwarden Instance

from pyLinkwarden.api import Client
c = Client(endpoint='https://linkwarden.example.com', access_token='<access token>')
Task Code Example
Collections Return requests library response c.collections._get_raw()
Return JSON c.collections._get()
Return list c.collections.list()
Delete c.collections.delete($id)
Links Return requests library response c.links._get_raw()
Return JSON c.links._get()
Return list c.links.list()
Delete c.links.delete($id)
Tags Return requests library response c.tags._get_raw()
Return JSON c.tags._get()
Return list c.tags.list()
Delete c.tags.delete($id)
Rename c.tags.rename($id, '$new_name')