sea-serpent
A dataframe-like wrapper around the SeaTable API.
Highlights
- DataFrame-like interface: Interact with your tables as if they were local pandas DataFrames. No more wrestling with the API!
- Automatic data type handling: No more manual conversions. Just work with your data and let
sea-serpenthandle the rest. - Read and write access: Fetch data, add new columns, update existing values, and even create new tables - all with the same intuitive interface.
- Easy authentication management: Store your API tokens securely and switch between multiple SeaTable instances with ease.
Install
From PyPI:
pip3 install sea-serpent
Bleeding edge from Github:
pip3 install git+https://github.com/schlegelp/sea-serpent@main
Examples
Getting your API (auth) token
In newer versions of SeaTable, you can get your API token directly from the website: Go to Personal Settings -> Account Token and copy the token from there. Then you can store it for later use:
>>> import seaserpent as ss
>>> ss.set_auth_token(token='YOUR_ACCOUNT_TOKEN', server='https://cloud.seatable.io')
Saved SeaTable auth token to ~/.seaserpent/secrets/instance.cloud.seatable.io.json
'YOUR_ACCOUNT_TOKEN'
If you work with an older instance of SeaTable, you can get your API token by providing your username and password:
>>> import seaserpent as ss
>>> ss.get_auth_token(username='USER',
... password='PASSWORD',
... server='https://cloud.seatable.io')
Saved SeaTable auth token to ~/.seaserpent/secrets/instance.cloud.seatable.io.json
{'token': 'YOUR_ACCOUNT_TOKEN'}
Note how the token is tied to a specific server. This enables you to work with multiple SeaTable instances at
the same time by just switching the server URL and let sea-serpent handle the rest. When working with tables,
you can either provide the server explicitly (via the server argument) or set a default server URL via the SEATABLE_SERVER environment variable.
For legacy reasons, we also support a SEATABLE_TOKEN environment variable for the auth token. The resolution
order is:
- Explicit
auth_tokenviaserverargument - Host-specific secret file:
instance.<host>.json - General secret file:
seatable_secret.json SEATABLE_TOKENenvironment variable (legacy)
Fine-grained (base-level) access tokens
Besides account tokens, SeaTable can issue base-level "API tokens" that are restricted to a
single base and can be read-only or read+write (Base -> ... -> "Advanced" -> "API Tokens"). These
work everywhere an account token does — pass one as auth_token (or store it via set_auth_token /
SEATABLE_TOKEN) and sea-serpent auto-detects the token type:
>>> import seaserpent as ss
>>> t = ss.Table('MyTable',
... auth_token='YOUR_BASE_TOKEN',
... server='https://cloud.seatable.io')
A base-level token is tied to exactly one base, so there is no base/workspace look-up — you don't
even need to pass base. You still need to specify the server (explicitly or via
SEATABLE_SERVER). Writes (including creating tables via Table.new / Table.from_frame) require a
read+write token; a read-only token will be rejected by the server on write attempts.
Initializing a table
Table works as connection to a single SeaTable table. If its name is unique,
you can initialize the connection with just the name:
>>> import seaserpent as ss
>>> # Initialize the table
>>> table = ss.Table(table='MyTable')
>>> table
SeaTable <"MyTable", 10 rows, 2 columns>
>>> # Inspect the first couple rows
>>> table.head()
column1 labels
0 1 A
1 2 B
2 3 C
If there are multiple tables with a given name, you need to also specify a base!
Fetching data
The Table itself doesn't download any of the data. Reading the data works
via an interface similar to pandas.DataFrames:
>>> # Fetching a column returns a promise
>>> c = table['column1'] # this works too: c = table.column1
>>> c
Column <column="column1", table="LH_bodies", datatype=number>
>>> # To get the values
>>> c.values
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>>> # Filters are automatically translated into SQL query
>>> table.loc[table.column1 >= 7]
column1 labels
0 7 H
1 8 I
2 9 J
>>> table.loc[table.labels.isin(['D', 'E']) ]
column1 labels
0 4 D
1 5 E
>>> # Download the whole table as pandas DataFrame
>>> df = table.to_frame()
Adding a column
>>> # First we need to re-initialize the table with write access
>>> table = ss.Table(table='MyTable', read_only=False)
>>> table.add_column(col_name='checked', col_type=bool)
>>> # The column will be empty
>>> table.head()
column1 labels checked
0 1 A None
1 2 B None
2 3 C None
Pushing data to table
>>> # Overwrite the whole column
>>> table['checked'] = False
>>> table.head()
column1 labels checked
0 1 A False
1 2 B False
2 3 C False
>>> # Alternatively pass a list of values
>>> table['checked'] = [False, True, False]
>>> table.head()
column1 labels checked
0 1 A False
1 2 B True
2 3 C False
>>> # Write to a subset of the column
>>> table.loc[:2, 'checked'] = False
>>> table.loc[table.labels == 'C', 'checked'] = True
>>> table.head()
column1 labels checked
0 1 A False
1 2 B False
2 3 C True
>>> # To write only changed values to the table
>>> # (faster & better for logs)
>>> values = table.checked.values
>>> values[0:2] = True # Change only two values
>>> table.checked.update(values)
Deleting a column
>>> table['checked'].delete()
>>> table.head()
column1 labels
0 1 A
1 2 B
2 3 C
>>> # Alternatively you can also clear an entire column
>>> table.checked.clear()
>>> table.head()
column1 labels checked
0 1 A None
1 2 B None
2 3 C None
Creating a new table
Empty table:
>>> table = ss.Table.new(table_name='MyNewTable', base='MyBase')
From pandas DataFrame:
>>> table = ss.Table.from_frame(df, table_name='MyNewTable', base='MyBase')
Linking tables
Create links:
>>> table.link(other_table='OtherTable', # name of the other table (must be same base)
... link_on='Column1', # column in this table to link on
... link_on_other='ColumnA', # column in other table to link on
... link_col='OtherTableLinks') # name of column to store links in
Create column that pulls data from linked table:
>>> table.add_linked_column(col_name='LinkedData', # name of new column
... link_col='OtherTableLinks', # column with link(s) to other table
... link_on='some_value', # which column in other table to link to
... formula='lookup') # how to aggregate data (lookup, mean, max, etc)
Additional Notes & Limitations
- For convenience and ease of access we're using names to identify tables, columns and bases. Hence you should avoid duplicate names if at all possible.
- 64-bit integers/floats are truncated when writing to a table. I suspect this
happens on the server side when decoding the JSON payload because manually
entering large numbers through the web interface works perfectly well
(copy-pasting still fails though). Hence,
sea-serpentquietly downcasts 64 bit to 32-bit if possible and failing that converts to strings before uploading. - The web interface appears to only show floats up to the 8th decimal. In the database the precision must be higher though because I have successfully written 1e-128 floats.
- Infinite values (i.e.
np.inf) raise an error when trying to write. - Cells manually cleared through the UI return empty strings (
''). By default,sea-serpentwill silently convert these toNone.
Metadata
Release files for sea-serpent 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sea_serpent-0.6.0.tar.gz | 62.4 kB | Without provenance | Details for sea_serpent-0.6.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sea_serpent-0.6.0-py3-none-any.whl | Python 3 | none | any | Details for sea_serpent-0.6.0-py3-none-any.whl |
Total release size: 120.2 kB
Release files / sea_serpent-0.6.0.tar.gz
| Download URL | sea_serpent-0.6.0.tar.gz |
|---|---|
| Size | 62.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
31b7b3c7b62f1cd4c6d8995ac6188c0c2007a3dfb4ee48880b29f19f95d5a54c
|
|
BLAKE2b-256 checksum How to use checksums |
b9e19b725ed2d1c41c2b5a418211f57d2bd4740fc1a36e51f3840e453cbee877
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / sea_serpent-0.6.0-py3-none-any.whl
| Download URL | sea_serpent-0.6.0-py3-none-any.whl |
|---|---|
| Size | 57.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
14d51714211019da6002649d137ced02d1ab7b38f8be46f0820fda741af6789f
|
|
BLAKE2b-256 checksum How to use checksums |
260ac4fcb47b0be085368ffbf243f0f0216c36f4436423025b3e599f32520353
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for sea-serpent 0.6.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.