aiolinkding


Nameaiolinkding JSON
Version 2023.12.0 PyPI version JSON
download
home_pagehttps://github.com/bachya/aiolinkding
SummaryA Python3, async interface to the linkding REST API
upload_time2023-12-18 01:47:09
maintainer
docs_urlNone
authorAaron Bach
requires_python>=3.10,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 🔖 aiolinkding: a Python3, async library to the linkding REST API

[![CI][ci-badge]][ci]
[![PyPI][pypi-badge]][pypi]
[![Version][version-badge]][version]
[![License][license-badge]][license]
[![Code Coverage][codecov-badge]][codecov]
[![Maintainability][maintainability-badge]][maintainability]

<a href="https://www.buymeacoffee.com/bachya1208P" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>

`aiolinkding` is a Python3, async library that interfaces with [linkding][linkding]
instances. It is intended to be a reasonably light wrapper around the linkding API
(meaning that instead of drowning the user in custom objects/etc., it focuses on
returning JSON straight from the API).

- [Installation](#installation)
- [Python Versions](#python-versions)
- [Usage](#usage)
  - [Creating a Client](#creating-a-client)
  - [Working with Bookmarks](#working-with-bookmarks)
    - [Getting All Bookmarks](#getting-all-bookmarks)
    - [Getting Archived Bookmarks](#getting-archived-bookmarks)
    - [Getting a Single Bookmark](#getting-a-single-bookmark-by-id)
    - [Creating a New Bookmark](#creating-a-new-bookmark)
    - [Updating an Existing Bookmark by ID](#updating-an-existing-bookmark-by-id)
    - [Archiving/Unarchiving a Bookmark](#archivingunarchiving-a-bookmark)
    - [Deleting a Bookmark](#deleting-a-bookmark)
  - [Working with Tags](#working-with-tags)
    - [Getting All Tags](#getting-all-tags)
    - [Getting a Single Tag](#getting-a-single-tag-by-id)
    - [Creating a New Tag](#creating-a-new-Tag)
  - [Working with User Data](#working-with-user-data)
    - [Getting Profile Info](#getting-profile-info)
  - [Connection Pooling](#connection-pooling)
- [Contributing](#contributing)

# Installation

```bash
pip install aiolinkding
```

# Python Versions

`aiolinkding` is currently supported on:

- Python 3.10
- Python 3.11
- Python 3.12

# 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

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")


asyncio.run(main())
```

## Working with Bookmarks

### Getting All Bookmarks

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

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


asyncio.run(main())
```

`client.bookmarks.async_get_all()` takes three optional parameters:

- `query`: a string query to filter the returned bookmarks
- `limit`: the maximum number of results that should be returned
- `offset`: the index from which to return results (e.g., `5` starts at the fifth bookmark)

### Getting Archived Bookmarks

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

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


asyncio.run(main())
```

`client.bookmarks.async_get_archived()` takes three optional parameters:

- `query`: a string query to filter the returned bookmarks
- `limit`: the maximum number of results that should be returned
- `offset`: the index from which to return results (e.g., `5` starts at the fifth bookmark)

### Getting a Single Bookmark by ID

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Get a single bookmark:
    bookmark = await client.bookmarks.async_get_single(37)
    # >>> { "id": 37, "url": "https://example.com", "title": "Example title", ... }


asyncio.run(main())
```

### Creating a New Bookmark

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Create a new bookmark:
    created_bookmark = await client.bookmarks.async_create(
        "https://example.com",
        title="Example title",
        description="Example description",
        tag_names=[
            "tag1",
            "tag2",
        ],
    )
    # >>> { "id": 37, "url": "https://example.com", "title": "Example title", ... }


asyncio.run(main())
```

`client.bookmarks.async_create()` takes four optional parameters:

- `title`: the bookmark's title
- `description`: the bookmark's description
- `notes`: Markdown notes to add to the bookmark
- `tag_names`: the tags to assign to the bookmark (represented as a list of strings)
- `is_archived`: whether the newly-created bookmark should automatically be archived
- `unread`: whether the newly-created bookmark should be marked as unread
- `shared`: whether the newly-created bookmark should be shareable with other linkding users

### Updating an Existing Bookmark by ID

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Update an existing bookmark:
    updated_bookmark = await client.bookmarks.async_update(
        37,
        url="https://different-example.com",
        title="Different example title",
        description="Different example description",
        tag_names=[
            "tag1",
            "tag2",
        ],
    )
    # >>> { "id": 37, "url": "https://different-example.com", ... }


asyncio.run(main())
```

`client.bookmarks.async_update()` takes four optional parameters (inclusion of any parameter
will change that value for the existing bookmark):

- `url`: the bookmark's URL
- `title`: the bookmark's title
- `description`: the bookmark's description
- `notes`: Markdown notes to add to the bookmark
- `tag_names`: the tags to assign to the bookmark (represented as a list of strings)
- `unread`: whether the bookmark should be marked as unread
- `shared`: whether the bookmark should be shareable with other linkding users

### Archiving/Unarchiving a Bookmark

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Archive a bookmark by ID:
    await client.bookmarks.async_archive(37)

    # ...and unarchive it:
    await client.bookmarks.async_unarchive(37)


asyncio.run(main())
```

### Deleting a Bookmark

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Delete a bookmark by ID:
    await client.bookmarks.async_delete(37)


asyncio.run(main())
```

## Working with Tags

### Getting All Tags

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Get all tags:
    tags = await client.tags.async_get_all()
    # >>> { "count": 100, "next": null, "previous": null, "results": [...] }


asyncio.run(main())
```

`client.tags.async_get_all()` takes two optional parameters:

- `limit`: the maximum number of results that should be returned
- `offset`: the index from which to return results (e.g., `5` starts at the fifth bookmark)

### Getting a Single Tag by ID

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Get a single tag:
    tag = await client.tags.async_get_single(22)
    # >>> { "id": 22, "name": "example-tag", ... }


asyncio.run(main())
```

### Creating a New Tag

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Create a new tag:
    created_tag = await client.tags.async_create("example-tag")
    # >>> { "id": 22, "name": "example-tag", ... }


asyncio.run(main())
```

## Working with User Data

### Getting Profile Info

```python
import asyncio

from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    client = await async_get_client("http://127.0.0.1:8000", "token_abcde12345")

    # Get all tags:
    tags = await client.user.async_get_profile()
    # >>> { "theme": "auto", "bookmark_date_display": "relative", ... }


asyncio.run(main())
```

## Connection Pooling

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`][aiohttp] `ClientSession` can be used for
connection pooling:

```python
import asyncio

from aiohttp import async_get_clientSession
from aiolinkding import async_get_client


async def main() -> None:
    """Use aiolinkding for fun and profit."""
    async with ClientSession() as session:
        client = await async_get_client(
            "http://127.0.0.1:8000", "token_abcde12345", session=session
        )

        # Get to work...


asyncio.run(main())
```

# Contributing

Thanks to all of [our contributors][contributors] so far!

1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].
2. [Fork the repository][fork].
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 on a new branch.
7. Write tests that cover your new functionality.
8. Run tests and ensure 100% code coverage: `poetry run pytest --cov aiolinkding tests`
9. Update `README.md` with any new documentation.
10. Submit a pull request!

[aiohttp]: https://github.com/aio-libs/aiohttp
[linkding]: https://github.com/sissbruecker/linkding
[ci-badge]: https://github.com/bachya/aiolinkding/workflows/CI/badge.svg
[ci]: https://github.com/bachya/aiolinkding/actions
[codecov-badge]: https://codecov.io/gh/bachya/aiolinkding/branch/dev/graph/badge.svg
[codecov]: https://codecov.io/gh/bachya/aiolinkding
[contributors]: https://github.com/bachya/aiolinkding/graphs/contributors
[fork]: https://github.com/bachya/aiolinkding/fork
[issues]: https://github.com/bachya/aiolinkding/issues
[license-badge]: https://img.shields.io/pypi/l/aiolinkding.svg
[license]: https://github.com/bachya/aiolinkding/blob/main/LICENSE
[maintainability-badge]: https://api.codeclimate.com/v1/badges/189379773edd4035a612/maintainability
[maintainability]: https://codeclimate.com/github/bachya/aiolinkding/maintainability
[new-issue]: https://github.com/bachya/aiolinkding/issues/new
[new-issue]: https://github.com/bachya/aiolinkding/issues/new
[pypi-badge]: https://img.shields.io/pypi/v/aiolinkding.svg
[pypi]: https://pypi.python.org/pypi/aiolinkding
[version-badge]: https://img.shields.io/pypi/pyversions/aiolinkding.svg
[version]: https://pypi.python.org/pypi/aiolinkding

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bachya/aiolinkding",
    "name": "aiolinkding",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Aaron Bach",
    "author_email": "bachya1208@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d8/e6/9f5341739ba06f8a8e5051761a011a367a4884a908db9d811b0cc7c92f65/aiolinkding-2023.12.0.tar.gz",
    "platform": null,
    "description": "# \ud83d\udd16 aiolinkding: a Python3, async library to the linkding REST API\n\n[![CI][ci-badge]][ci]\n[![PyPI][pypi-badge]][pypi]\n[![Version][version-badge]][version]\n[![License][license-badge]][license]\n[![Code Coverage][codecov-badge]][codecov]\n[![Maintainability][maintainability-badge]][maintainability]\n\n<a href=\"https://www.buymeacoffee.com/bachya1208P\" target=\"_blank\"><img src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"></a>\n\n`aiolinkding` is a Python3, async library that interfaces with [linkding][linkding]\ninstances. It is intended to be a reasonably light wrapper around the linkding API\n(meaning that instead of drowning the user in custom objects/etc., it focuses on\nreturning JSON straight from the API).\n\n- [Installation](#installation)\n- [Python Versions](#python-versions)\n- [Usage](#usage)\n  - [Creating a Client](#creating-a-client)\n  - [Working with Bookmarks](#working-with-bookmarks)\n    - [Getting All Bookmarks](#getting-all-bookmarks)\n    - [Getting Archived Bookmarks](#getting-archived-bookmarks)\n    - [Getting a Single Bookmark](#getting-a-single-bookmark-by-id)\n    - [Creating a New Bookmark](#creating-a-new-bookmark)\n    - [Updating an Existing Bookmark by ID](#updating-an-existing-bookmark-by-id)\n    - [Archiving/Unarchiving a Bookmark](#archivingunarchiving-a-bookmark)\n    - [Deleting a Bookmark](#deleting-a-bookmark)\n  - [Working with Tags](#working-with-tags)\n    - [Getting All Tags](#getting-all-tags)\n    - [Getting a Single Tag](#getting-a-single-tag-by-id)\n    - [Creating a New Tag](#creating-a-new-Tag)\n  - [Working with User Data](#working-with-user-data)\n    - [Getting Profile Info](#getting-profile-info)\n  - [Connection Pooling](#connection-pooling)\n- [Contributing](#contributing)\n\n# Installation\n\n```bash\npip install aiolinkding\n```\n\n# Python Versions\n\n`aiolinkding` is currently supported on:\n\n- Python 3.10\n- Python 3.11\n- Python 3.12\n\n# Usage\n\n## Creating a Client\n\nIt's easy to create an API client for a linkding instance. All you need are two\nparameters:\n\n1. A URL to a linkding instance\n2. A linkding API token\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n\nasyncio.run(main())\n```\n\n## Working with Bookmarks\n\n### Getting All Bookmarks\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Get all bookmarks:\n    bookmarks = await client.bookmarks.async_get_all()\n    # >>> { \"count\": 100, \"next\": null, \"previous\": null, \"results\": [...] }\n\n\nasyncio.run(main())\n```\n\n`client.bookmarks.async_get_all()` takes three optional parameters:\n\n- `query`: a string query to filter the returned bookmarks\n- `limit`: the maximum number of results that should be returned\n- `offset`: the index from which to return results (e.g., `5` starts at the fifth bookmark)\n\n### Getting Archived Bookmarks\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Get all archived bookmarks:\n    bookmarks = await client.bookmarks.async_get_archived()\n    # >>> { \"count\": 100, \"next\": null, \"previous\": null, \"results\": [...] }\n\n\nasyncio.run(main())\n```\n\n`client.bookmarks.async_get_archived()` takes three optional parameters:\n\n- `query`: a string query to filter the returned bookmarks\n- `limit`: the maximum number of results that should be returned\n- `offset`: the index from which to return results (e.g., `5` starts at the fifth bookmark)\n\n### Getting a Single Bookmark by ID\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Get a single bookmark:\n    bookmark = await client.bookmarks.async_get_single(37)\n    # >>> { \"id\": 37, \"url\": \"https://example.com\", \"title\": \"Example title\", ... }\n\n\nasyncio.run(main())\n```\n\n### Creating a New Bookmark\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Create a new bookmark:\n    created_bookmark = await client.bookmarks.async_create(\n        \"https://example.com\",\n        title=\"Example title\",\n        description=\"Example description\",\n        tag_names=[\n            \"tag1\",\n            \"tag2\",\n        ],\n    )\n    # >>> { \"id\": 37, \"url\": \"https://example.com\", \"title\": \"Example title\", ... }\n\n\nasyncio.run(main())\n```\n\n`client.bookmarks.async_create()` takes four optional parameters:\n\n- `title`: the bookmark's title\n- `description`: the bookmark's description\n- `notes`: Markdown notes to add to the bookmark\n- `tag_names`: the tags to assign to the bookmark (represented as a list of strings)\n- `is_archived`: whether the newly-created bookmark should automatically be archived\n- `unread`: whether the newly-created bookmark should be marked as unread\n- `shared`: whether the newly-created bookmark should be shareable with other linkding users\n\n### Updating an Existing Bookmark by ID\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Update an existing bookmark:\n    updated_bookmark = await client.bookmarks.async_update(\n        37,\n        url=\"https://different-example.com\",\n        title=\"Different example title\",\n        description=\"Different example description\",\n        tag_names=[\n            \"tag1\",\n            \"tag2\",\n        ],\n    )\n    # >>> { \"id\": 37, \"url\": \"https://different-example.com\", ... }\n\n\nasyncio.run(main())\n```\n\n`client.bookmarks.async_update()` takes four optional parameters (inclusion of any parameter\nwill change that value for the existing bookmark):\n\n- `url`: the bookmark's URL\n- `title`: the bookmark's title\n- `description`: the bookmark's description\n- `notes`: Markdown notes to add to the bookmark\n- `tag_names`: the tags to assign to the bookmark (represented as a list of strings)\n- `unread`: whether the bookmark should be marked as unread\n- `shared`: whether the bookmark should be shareable with other linkding users\n\n### Archiving/Unarchiving a Bookmark\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Archive a bookmark by ID:\n    await client.bookmarks.async_archive(37)\n\n    # ...and unarchive it:\n    await client.bookmarks.async_unarchive(37)\n\n\nasyncio.run(main())\n```\n\n### Deleting a Bookmark\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Delete a bookmark by ID:\n    await client.bookmarks.async_delete(37)\n\n\nasyncio.run(main())\n```\n\n## Working with Tags\n\n### Getting All Tags\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Get all tags:\n    tags = await client.tags.async_get_all()\n    # >>> { \"count\": 100, \"next\": null, \"previous\": null, \"results\": [...] }\n\n\nasyncio.run(main())\n```\n\n`client.tags.async_get_all()` takes two optional parameters:\n\n- `limit`: the maximum number of results that should be returned\n- `offset`: the index from which to return results (e.g., `5` starts at the fifth bookmark)\n\n### Getting a Single Tag by ID\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Get a single tag:\n    tag = await client.tags.async_get_single(22)\n    # >>> { \"id\": 22, \"name\": \"example-tag\", ... }\n\n\nasyncio.run(main())\n```\n\n### Creating a New Tag\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Create a new tag:\n    created_tag = await client.tags.async_create(\"example-tag\")\n    # >>> { \"id\": 22, \"name\": \"example-tag\", ... }\n\n\nasyncio.run(main())\n```\n\n## Working with User Data\n\n### Getting Profile Info\n\n```python\nimport asyncio\n\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    client = await async_get_client(\"http://127.0.0.1:8000\", \"token_abcde12345\")\n\n    # Get all tags:\n    tags = await client.user.async_get_profile()\n    # >>> { \"theme\": \"auto\", \"bookmark_date_display\": \"relative\", ... }\n\n\nasyncio.run(main())\n```\n\n## Connection Pooling\n\nBy default, the library creates a new connection to linkding with each coroutine. If you\nare calling a large number of coroutines (or merely want to squeeze out every second of\nruntime savings possible), an [`aiohttp`][aiohttp] `ClientSession` can be used for\nconnection pooling:\n\n```python\nimport asyncio\n\nfrom aiohttp import async_get_clientSession\nfrom aiolinkding import async_get_client\n\n\nasync def main() -> None:\n    \"\"\"Use aiolinkding for fun and profit.\"\"\"\n    async with ClientSession() as session:\n        client = await async_get_client(\n            \"http://127.0.0.1:8000\", \"token_abcde12345\", session=session\n        )\n\n        # Get to work...\n\n\nasyncio.run(main())\n```\n\n# Contributing\n\nThanks to all of [our contributors][contributors] so far!\n\n1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].\n2. [Fork the repository][fork].\n3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`\n4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`\n5. Install the dev environment: `script/setup`\n6. Code your new feature or bug fix on a new branch.\n7. Write tests that cover your new functionality.\n8. Run tests and ensure 100% code coverage: `poetry run pytest --cov aiolinkding tests`\n9. Update `README.md` with any new documentation.\n10. Submit a pull request!\n\n[aiohttp]: https://github.com/aio-libs/aiohttp\n[linkding]: https://github.com/sissbruecker/linkding\n[ci-badge]: https://github.com/bachya/aiolinkding/workflows/CI/badge.svg\n[ci]: https://github.com/bachya/aiolinkding/actions\n[codecov-badge]: https://codecov.io/gh/bachya/aiolinkding/branch/dev/graph/badge.svg\n[codecov]: https://codecov.io/gh/bachya/aiolinkding\n[contributors]: https://github.com/bachya/aiolinkding/graphs/contributors\n[fork]: https://github.com/bachya/aiolinkding/fork\n[issues]: https://github.com/bachya/aiolinkding/issues\n[license-badge]: https://img.shields.io/pypi/l/aiolinkding.svg\n[license]: https://github.com/bachya/aiolinkding/blob/main/LICENSE\n[maintainability-badge]: https://api.codeclimate.com/v1/badges/189379773edd4035a612/maintainability\n[maintainability]: https://codeclimate.com/github/bachya/aiolinkding/maintainability\n[new-issue]: https://github.com/bachya/aiolinkding/issues/new\n[new-issue]: https://github.com/bachya/aiolinkding/issues/new\n[pypi-badge]: https://img.shields.io/pypi/v/aiolinkding.svg\n[pypi]: https://pypi.python.org/pypi/aiolinkding\n[version-badge]: https://img.shields.io/pypi/pyversions/aiolinkding.svg\n[version]: https://pypi.python.org/pypi/aiolinkding\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python3, async interface to the linkding REST API",
    "version": "2023.12.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/bachya/aiolinkding/issues",
        "Changelog": "https://github.com/bachya/aiolinkding/releases",
        "Homepage": "https://github.com/bachya/aiolinkding",
        "Repository": "https://github.com/bachya/aiolinkding"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f403de0809c4194a817aaebf8eeb0e986eb1e4d22f65b81b297381e5422be064",
                "md5": "64e9737e5339b9733ce8bfc1cf8f2cfa",
                "sha256": "e950a8aa263d12678204a83f8394104cf51abf411ba619af27096701e8ebb4af"
            },
            "downloads": -1,
            "filename": "aiolinkding-2023.12.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64e9737e5339b9733ce8bfc1cf8f2cfa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 10523,
            "upload_time": "2023-12-18T01:47:07",
            "upload_time_iso_8601": "2023-12-18T01:47:07.354088Z",
            "url": "https://files.pythonhosted.org/packages/f4/03/de0809c4194a817aaebf8eeb0e986eb1e4d22f65b81b297381e5422be064/aiolinkding-2023.12.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d8e69f5341739ba06f8a8e5051761a011a367a4884a908db9d811b0cc7c92f65",
                "md5": "ef5425be9f9f27b3b8f8a8db4c7f4ef0",
                "sha256": "b4af5d1b12cec2ee8d5f75be4c106bc39cc9e38cedc706e3a8b7f39e696c3671"
            },
            "downloads": -1,
            "filename": "aiolinkding-2023.12.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ef5425be9f9f27b3b8f8a8db4c7f4ef0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 11296,
            "upload_time": "2023-12-18T01:47:09",
            "upload_time_iso_8601": "2023-12-18T01:47:09.102039Z",
            "url": "https://files.pythonhosted.org/packages/d8/e6/9f5341739ba06f8a8e5051761a011a367a4884a908db9d811b0cc7c92f65/aiolinkding-2023.12.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-18 01:47:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bachya",
    "github_project": "aiolinkding",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "aiolinkding"
}
        
Elapsed time: 0.16328s