Seshat API

Caution

⚠️ This package is currently in the very early stages of development and is not yet functional. We are actively working on building and testing the core features, and many components are either incomplete or subject to significant changes.

Please do not use this package in any production environment as it may contain numerous bugs, lack essential features, and undergo frequent breaking changes. We welcome contributions and feedback, but users should proceed with caution and understand the current limitations.

Thank you for your understanding and patience as we work towards a stable release.

This is the Python binding for the Seshat API. The Seshat API is a RESTful API that allows you to interact with the Seshat database. The Seshat database is a database of historical and archaeological data. The Seshat API allows you to query the database and retrieve data in a structured format.

Installation

To install the Seshat API, you can use pip:

git clone https://github.com/Seshat-Global-History-Databank/seshat_api
cd seshat_api
pip install .

Usage

To use the Seshat API, you need to create a SeshatAPI client object and use it to interact with the database.

The best way to get started is to try one of our example notebooks, which demo how to use the package.

Quick start

Here is an example of how to set up a client:

from seshat_api import SeshatAPI

# Set up a client
client = SeshatAPI(username="<USERNAME>", password="<PASSWORD>")

Here is an example of how to use the API to retrieve data from the database:

# Get all the polities in the database
from seshat_api.core import Polities

polities = Polities(client)

# Show me how many polities are in the database
print(len(polities))

# Iterate through the polities
for polity in polities:
    print(polity.id, polity.name)

Documentation

For more information on how to use the Seshat API, please refer to the documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.