Impresso Python Library

Impresso is a library designed to facilitate interaction with the Impresso dataset. It offers a comprehensive set of classes for API interaction and a variety of tools to streamline data manipulation and analysis.

You can find the full documentation at https://impresso.github.io/impresso-py/.

Installation

With pip:

pip install impresso

Usage

See sample notebooks in the examples/notebooks directory or examples available in the Impresso Datalab.

Extending the library

We use Poetry for dependency management. To install the package in development mode, run the following command in the root directory of the project:

poetry install

This will create and activate a virtual environment with all the dependencies installed.

Testing

poetry run pytest

Linting

poetry run pytest
poetry run flake8 impresso tests
poetry run mypy impresso tests

OpenAPI client generation

The OpenAPI client is generated using the OpenAPI Generator. Pydantic models from the OpenAPI spec are generated too. The following command generates both the client code and the pydantic models. Make sure the Public API is running on localhost.:

poetry run generate-client

Whenever the OpenAPI spec of the Impresso Public API changes, the client code and the pydantic models must be regenerated.

Protobuf

Filters used in some endpoints are serialized as a protobuf message. The protobuf message is defined in the impresso-jscommons project. The python code is generated using the protoc compiler (must be installed separately). The following command generates the python code for the protobuf message:

poetry run generate-protobuf

About Impresso

Impresso project

Impresso - Media Monitoring of the Past is an interdisciplinary research project that aims to develop and consolidate tools for processing and exploring large collections of media archives across modalities, time, languages and national borders. The first project (2017-2021) was funded by the Swiss National Science Foundation under grant No. CRSII5_173719 and the second project (2023-2027) by the SNSF under grant No. CRSII5_213585 and the Luxembourg National Research Fund under grant No. 17498891.

Copyright

Copyright (C) 2024 The Impresso team.

License

This program is provided as open source under the GNU Affero General Public License v3 or later.