pynocodb

Name	pynocodb JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	python sdk for nocodb restful api
upload_time	2024-08-23 08:28:46
maintainer	None
docs_url	None
author	liunux
requires_python	<4.0,>=3.8
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ## description
A wrapper to access nocodb [restful api](https://meta-apis-v2.nocodb.com/) using httpx

## functions
test with nocodb v0.255.0

|API endpoint<br>sub module|list|read|update|create|delete|links|
|--------------------------|----|----|------|------|------|-----|
|Auth|✅|✅|✅|✅|❌︎|-|
|Users for base|✅|✅|✅|✅|✅|-|
|Bases|✅|✅|✅|✅|✅|-|
|Record|✅|✅|✅|✅|✅|✅|
|Table|✅|✅|✅|✅|✅|-|
|Column|✅|✅|❌︎|❌︎|❌︎|-|
|View|❌︎|❌︎|❌︎|❌︎|❌︎|-|

## example
### sync mode
```python3
from pynocodb import Client
from rich import print


def run_sync():
    # here we use an api token.
    # you can do client.auth.signin to use auth token instead
    client = Client(token="YzDNLisEZQ4AuId1i9sodHbDC2eEJxadiAlRUHXu")

    bases = client.base.get_base_ids()
    print(bases)
    base_id = list(bases.values())[0]
    tables = client.table.get_table_ids(base_id)
    print(tables)
    table_id = list(tables.values())[0]
    print(client.record.list_records(table_id)["list"])


if __name__ == "__main__":
    run_sync()
```

### async mode
```python3
import asyncio

from pynocodb import AsyncClient
from rich import print


async def run_async():
    client = AsyncClient()
    await client.auth.signin("liunux@qq.com", "r_PypPUajC6y!2B")

    bases = await client.base.get_base_ids()
    print(bases)
    base_id = list(bases.values())[0]
    tables = await client.table.get_table_ids(base_id)
    print(tables)
    table_id = list(tables.values())[0]
    print((await client.record.list_records(table_id))["list"])


if __name__ == "__main__":
    asyncio.run(run_async())
```

## TODOs:
- [ ] use pydantic to define schemas for table, column, source, base, etc.
- [ ] support column creation & update
- [ ] support view creation & update


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pynocodb",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "liunux",
    "author_email": "liunux@qq.com",
    "download_url": null,
    "platform": null,
    "description": "## description\nA wrapper to access nocodb [restful api](https://meta-apis-v2.nocodb.com/) using httpx\n\n## functions\ntest with nocodb v0.255.0\n\n|API endpoint<br>sub module|list|read|update|create|delete|links|\n|--------------------------|----|----|------|------|------|-----|\n|Auth|\u2705|\u2705|\u2705|\u2705|\u274c\ufe0e|-|\n|Users for base|\u2705|\u2705|\u2705|\u2705|\u2705|-|\n|Bases|\u2705|\u2705|\u2705|\u2705|\u2705|-|\n|Record|\u2705|\u2705|\u2705|\u2705|\u2705|\u2705|\n|Table|\u2705|\u2705|\u2705|\u2705|\u2705|-|\n|Column|\u2705|\u2705|\u274c\ufe0e|\u274c\ufe0e|\u274c\ufe0e|-|\n|View|\u274c\ufe0e|\u274c\ufe0e|\u274c\ufe0e|\u274c\ufe0e|\u274c\ufe0e|-|\n\n## example\n### sync mode\n```python3\nfrom pynocodb import Client\nfrom rich import print\n\n\ndef run_sync():\n    # here we use an api token.\n    # you can do client.auth.signin to use auth token instead\n    client = Client(token=\"YzDNLisEZQ4AuId1i9sodHbDC2eEJxadiAlRUHXu\")\n\n    bases = client.base.get_base_ids()\n    print(bases)\n    base_id = list(bases.values())[0]\n    tables = client.table.get_table_ids(base_id)\n    print(tables)\n    table_id = list(tables.values())[0]\n    print(client.record.list_records(table_id)[\"list\"])\n\n\nif __name__ == \"__main__\":\n    run_sync()\n```\n\n### async mode\n```python3\nimport asyncio\n\nfrom pynocodb import AsyncClient\nfrom rich import print\n\n\nasync def run_async():\n    client = AsyncClient()\n    await client.auth.signin(\"liunux@qq.com\", \"r_PypPUajC6y!2B\")\n\n    bases = await client.base.get_base_ids()\n    print(bases)\n    base_id = list(bases.values())[0]\n    tables = await client.table.get_table_ids(base_id)\n    print(tables)\n    table_id = list(tables.values())[0]\n    print((await client.record.list_records(table_id))[\"list\"])\n\n\nif __name__ == \"__main__\":\n    asyncio.run(run_async())\n```\n\n## TODOs:\n- [ ] use pydantic to define schemas for table, column, source, base, etc.\n- [ ] support column creation & update\n- [ ] support view creation & update\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "python sdk for nocodb restful api",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "87b0895f84e317fa17dc8b14857f41b7a65f0108616c6c2b6540759fba6c87ca",
                "md5": "dcbf9e0a1b25ac1e27aac36924f26c4b",
                "sha256": "b5056ee6480d77a26242c2eaeb220663fc49c5c0e0b5c5479a156e802da07cc3"
            },
            "downloads": -1,
            "filename": "pynocodb-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dcbf9e0a1b25ac1e27aac36924f26c4b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 11814,
            "upload_time": "2024-08-23T08:28:46",
            "upload_time_iso_8601": "2024-08-23T08:28:46.335444Z",
            "url": "https://files.pythonhosted.org/packages/87/b0/895f84e317fa17dc8b14857f41b7a65f0108616c6c2b6540759fba6c87ca/pynocodb-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-23 08:28:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pynocodb"
}