plantable 0.0.1__tar.gz

plantable-0.0.1/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: plantable
+Version: 0.0.1
+Author: Woojin Cho
+Author-email: w.cho@cj.net
+License: MIT License
+Requires-Python: >=3.8
+Requires-Dist: aioboto3
+Requires-Dist: aiohttp==3.9.5
+Requires-Dist: aiokafka
+Requires-Dist: asyncpg
+Requires-Dist: charset-normalizer==2.1.0
+Requires-Dist: click
+Requires-Dist: click-loglevel
+Requires-Dist: dasida
+Requires-Dist: fastapi
+Requires-Dist: fastavro
+Requires-Dist: genson
+Requires-Dist: hiredis
+Requires-Dist: orjson
+Requires-Dist: pandas
+Requires-Dist: parse
+Requires-Dist: pendulum
+Requires-Dist: pyarrow
+Requires-Dist: pydantic==1.10
+Requires-Dist: pypika
+Requires-Dist: python-dotenv
+Requires-Dist: python-multipart
+Requires-Dist: python-socketio<5
+Requires-Dist: redis
+Requires-Dist: requests
+Requires-Dist: sqlalchemy[asyncio]
+Requires-Dist: sqlparse
+Requires-Dist: tabulate
+Requires-Dist: uvicorn

plantable-0.0.1/README.md

@@ -0,0 +1,57 @@
+# Plantable
+
+SeaTable Python SDK
+
+- `client` SeaTable을 제어 - 사용자 및 그룹 관리, 데이터 읽기 및 쓰기 등
+- `server` SeaTable의 데이터를 AWS S3 등으로 전송하는 HTTP Server
+
+
+
+## Client
+
+UserClient 사용 예제
+
+```python
+from plantable import UserClient
+
+# user client 생성
+uc = UserClient(
+    seatable_url="https://seatable.example.com", 
+    seatable_username="itsme", 
+    seatable_password="youknownothing"
+)
+
+# Workspace 리스트 보기
+await uc.ls()
+
+# Workspace 내 Base 리스트 보기
+await uc.ls("my-workspace")
+
+# Workspace / Base 내 리스트 보기 (Tables, Views)
+await uc.ls("my-workspace", "some-base")
+
+# BaseClient 생성하기 (Table 읽기/쓰기 위해서는 BaseClient 필요)
+bc = await uc.get_base_client_with_account_token("my-workspace", "some-base")
+
+# Table 읽기
+tbl = bc.read_table("my-table")
+
+# View 읽기
+view = bc.read_view("my-view")
+
+# Table 또는 View를 Pandas DataFrame으로 바꾸기 
+# 1. Pandas 이용
+import pandas as pd
+df = pd.DataFrame.from_records(tbl)
+
+# 2. PyArrow 이용
+import pyarrow as pa
+df = pa.Table.from_pylist(tbl).to_pandas()
+```
+
+
+
+
+
+## Server
+

plantable-0.0.1/pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning" ]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools-git-versioning]
+enabled = true
+template = "{tag}"

plantable-0.0.1/setup.cfg

@@ -0,0 +1,65 @@
+[metadata]
+name = plantable
+version = 2026.3.1
+description = 
+long_description = 
+author = Woojin Cho
+author_email = w.cho@cj.net
+keywords = 
+license = MIT License
+
+[options]
+dependency_links = 
+python_requires = >= 3.8
+package_dir = 
+	=src
+packages = find:
+install_requires = 
+	aioboto3
+	aiohttp == 3.9.5
+	aiokafka
+	asyncpg
+	charset-normalizer == 2.1.0
+	click
+	click-loglevel
+	dasida
+	fastapi
+	fastavro
+	genson
+	hiredis
+	orjson
+	pandas
+	parse
+	pendulum
+	pyarrow
+	pydantic == 1.10
+	pypika
+	python-dotenv
+	python-multipart
+	python-socketio < 5
+	redis
+	requests
+	sqlalchemy[asyncio]
+	sqlparse
+	tabulate
+	uvicorn
+include_package_data = True
+
+[options.packages.find]
+where = src
+
+[options.package_data]
+plantable = 
+	static/**/*
+	static/**/.*
+	static/.**/*
+	static/.**/.*
+
+[options.entry_points]
+console_scripts = 
+	plantable = plantable.scripts:plantable
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

plantable-0.0.1/src/plantable/__init__.py

@@ -0,0 +1,9 @@
+from importlib.metadata import PackageNotFoundError, version
+
+from .client import AccountClient, AdminClient, BaseClient, UserClient
+
+try:
+    __version__ = version("plantable")
+except PackageNotFoundError:
+    # package is not installed
+    pass

plantable-0.0.1/src/plantable/client/__init__.py

@@ -0,0 +1,4 @@
+from .account import AccountClient
+from .admin import AdminClient
+from .base import BaseClient
+from .user import UserClient

plantable-0.0.1/src/plantable/client/account.py

@@ -0,0 +1,227 @@
+import asyncio
+import logging
+from datetime import datetime
+from typing import List, Union
+
+import aiohttp
+import orjson
+import requests
+from pydantic import BaseModel
+from tabulate import tabulate
+
+from ..model import (
+    DTABLE_ICON_COLORS,
+    DTABLE_ICON_LIST,
+    Admin,
+    ApiToken,
+    Base,
+    BaseToken,
+    Column,
+    Table,
+    Team,
+    User,
+    Webhook,
+)
+from .base import BaseClient
+from .conf import SEATABLE_ACCOUNT_TOKEN, SEATABLE_PASSWORD, SEATABLE_URL, SEATABLE_USERNAME
+from .core import TABULATE_CONF, HttpClient
+
+logger = logging.getLogger()
+
+
+################################################################
+# AccountClient
+################################################################
+class AccountClient(HttpClient):
+    def __init__(
+        self,
+        seatable_url: str = SEATABLE_URL,
+        seatable_username: str = SEATABLE_USERNAME,
+        seatable_password: str = SEATABLE_PASSWORD,
+    ):
+        super().__init__(seatable_url=seatable_url)
+        self.username = seatable_username
+        self.password = seatable_password
+        self.account_token = None
+
+        self.is_admin = False
+
+        # do login
+        self.login()
+
+    def login(self):
+        auth_url = self.seatable_url + "/api2/auth-token/"
+        response = requests.post(auth_url, json={"username": self.username, "password": self.password})
+        response.raise_for_status()
+        results = response.json()
+        self.account_token = results["token"]
+
+    ################################################################
+    # AUTHENTICATION - API TOKEN
+    ################################################################
+    # [API TOKEN] list api tokens
+    async def list_api_tokens(self, workspace_id: str, base_name: str, model: BaseModel = ApiToken):
+        """
+        [NOTE]
+         workspace id : group = 1 : 1
+        """
+        METHOD = "GET"
+        URL = f"/api/v2.1/workspace/{workspace_id}/dtable/{base_name}/api-tokens/"
+        ITEM = "api_tokens"
+
+        async with self.session_maker(token=self.account_token) as session:
+            response = await self.request(session=session, method=METHOD, url=URL)
+            results = response[ITEM]
+
+        if model:
+            results = [model(**x) for x in results]
+
+        return results
+
+    # [API TOKEN] create api token
+    async def get_or_create_api_token(
+        self,
+        workspace_id: str,
+        base_name: str,
+        app_name: str,
+        permission: str = "rw",
+        model: BaseModel = ApiToken,
+    ):
+        """
+        [NOTE]
+         "bad request" returns if app_name is already exists.
+        """
+        api_tokens = await self.list_api_tokens(workspace_id=workspace_id, base_name=base_name)
+        for api_token in api_tokens:
+            if api_token.app_name == app_name:
+                return api_token
+
+        METHOD = "POST"
+        URL = f"/api/v2.1/workspace/{workspace_id}/dtable/{base_name}/api-tokens/"
+        JSON = {"app_name": app_name, "permission": permission}
+
+        async with self.session_maker(token=self.account_token) as session:
+            response = await self.request(session=session, method=METHOD, url=URL, json=JSON)
+            results = model(**response) if model else response
+
+        return results
+
+    # [API TOKEN] create temporary api token
+    async def create_temp_api_token(self, workspace_id: str, base_name: str, model: BaseModel = ApiToken):
+        METHOD = "GET"
+        URL = f"/api/v2.1/workspace/{workspace_id}/dtable/{base_name}/temp-api-token/"
+        ITEM = "api_token"
+
+        async with self.session_maker(token=self.account_token) as session:
+            response = await self.request(session=session, method=METHOD, url=URL)
+            results = response[ITEM]
+
+        if model:
+            now = datetime.now()
+            results = model(
+                app_name="__temp_token",
+                api_token=results,
+                generated_by="__temp_token",
+                generated_at=now,
+                last_access=now,
+                permission="r",
+            )
+
+        return results
+
+    # [API TOKEN] update api token
+    async def update_api_token(
+        self,
+        workspace_id: str,
+        base_name: str,
+        app_name: str,
+        permission: str = "rw",
+        model: BaseModel = ApiToken,
+    ):
+        METHOD = "PUT"
+        URL = f"/api/v2.1/workspace/{workspace_id}/dtable/{base_name}/api-tokens/{app_name}"
+        JSON = {"permission": permission}
+
+        async with self.session_maker(token=self.account_token) as session:
+            response = await self.request(session=session, method=METHOD, url=URL, json=JSON)
+            results = model(**response) if model else response
+
+        return results
+
+    # [API TOKEN] delete api token
+    async def delete_api_token(self, workspace_id: str, base_name: str, app_name: str):
+        METHOD = "DELETE"
+        URL = f"/api/v2.1/workspace/{workspace_id}/dtable/{base_name}/api-tokens/{app_name}"
+        ITEM = "success"
+
+        async with self.session_maker(token=self.account_token) as session:
+            response = await self.request(session=session, method=METHOD, url=URL)
+            results = response[ITEM]
+
+        return results
+
+    ################################################################
+    # AUTHENTICATION - BASE TOKEN
+    ################################################################
+    # [BASE TOKEN] get base token with account token
+    async def get_base_token_with_account_token(
+        self,
+        workspace_id: str = None,
+        base_name: str = None,
+        model: BaseModel = BaseToken,
+    ):
+        METHOD = "GET"
+        URL = f"/api/v2.1/workspace/{workspace_id}/dtable/{base_name}/access-token/"
+
+        async with self.session_maker(token=self.account_token) as session:
+            results = await self.request(session=session, method=METHOD, url=URL)
+        if model:
+            results = model(**results)
+
+        return results
+
+    # [BASE TOKEN] get base token with api token
+    async def get_base_token_with_api_token(self, api_token: str, model: BaseModel = BaseToken):
+        METHOD = "GET"
+        URL = "/api/v2.1/dtable/app-access-token/"
+
+        async with self.session_maker(token=api_token) as session:
+            results = await self.request(session=session, method=METHOD, url=URL)
+        if model:
+            results = model(**results)
+
+        return results
+
+    # [BASE TOKEN] get base token with invite link
+    async def get_base_token_with_invite_link(self, link: str, model: BaseModel = BaseToken):
+        link = link.rsplit("/links/", 1)[-1].strip("/")
+        METHOD = "GET"
+        URL = "/api/v2.1/dtable/share-link-access-token/"
+
+        async with self.session_maker(token=link) as session:
+            results = await self.request(session=session, method=METHOD, url=URL)
+        if model:
+            results = model(**results)
+
+        return results
+
+    # [BASE TOKEN] get base token with external link
+    async def get_base_token_with_external_link(self, link: str, model: BaseModel = BaseToken):
+        link = link.rsplit("/external-links/", 1)[-1].strip("/")
+        METHOD = "GET"
+        URL = f"/api/v2.1/external-link-tokens/{link}/access-token/"
+
+        async with self.session_maker(token=link) as session:
+            results = await self.request(session=session, method=METHOD, url=URL)
+        if model:
+            results = model(**results)
+
+        return results
+
+    ################################################################
+    # (CUSTOM) GET BASE CLIENT
+    ################################################################
+    # [BASE CLIENT] (custom) get base client with account token
+    async def get_base_client_with_account_token(self, workspace_id: str, base_name: str):
+        base_token = await self.get_base_token_with_account_token(workspace_id=workspace_id, base_name=base_name)
+        return BaseClient(base_token=base_token)