🚰 aiolinkding: DESCRIPTION

DESCRIPTION

• Installation
• Python Versions
• Usage
• Contributing

Installation

pip install aiolinkding

Python Versions

aiolinkding is currently supported on:

• Python 3.8
• Python 3.9
• Python 3.10

Usage

Creating a Client

It's easy to create an API client for a linkding instance. All you need are two parameters:

1. A URL to a linkding instance
2. A linkding API token

import asyncio

from aiohttp import ClientSession

from aiolinkding import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    client = Client("http://127.0.0.1:8000", "token_abcde12345")


asyncio.run(main())

Working with Bookmarks

The Client object provides easy access to several bookmark-related API operations:

import asyncio

from aiohttp import ClientSession

from aiolinkding import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    client = Client("http://127.0.0.1:8000", "token_abcde12345")

    # Get all bookmarks:
    bookmarks = await client.bookmarks.async_all()
    # >>> { "count": 5, "next": null, "previous": null, "results": [...] }


asyncio.run(main())

By default, the library creates a new connection to linkding with each coroutine. If you are calling a large number of coroutines (or merely want to squeeze out every second of runtime savings possible), an aiohttp ClientSession can be used for connection pooling:

import asyncio

from aiohttp import ClientSession

from aionotion import async_get_client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as session:
        # Create a Notion API client:
        client = Client("http://127.0.0.1:8000", "token_abcde12345", session=session)

        # Get to work...


asyncio.run(main())

Contributing

1. Check for open features/bugs or initiate a discussion on one.
2. Fork the repository.
3. (optional, but highly recommended) Create a virtual environment: python3 -m venv .venv
4. (optional, but highly recommended) Enter the virtual environment: source ./.venv/bin/activate
5. Install the dev environment: script/setup
6. Code your new feature or bug fix.
7. Write tests that cover your new functionality.
8. Run tests and ensure 100% code coverage: nox -rs coverage
9. Update README.md with any new documentation.
10. Add yourself to AUTHORS.md.
11. Submit a pull request!