Impresso Python

Impresso Project Logo

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.

Installation and prerequisites

The Impresso python library can be installed using pip:

pip install impresso

The library requires Python version 3.10 or higher. It also depends on several packages commonly found in Jupyter environments, such as matplotlib and pandas.

Create a session

`impresso.connect(public_api_url=None, persisted_token=True)`

Connect to the Impresso API and return a client object.

from impresso import connect

impresso = connect()

Parameters:

Name	Type	Description	Default
`public_api_url`	`str`	The URL of the Impresso API to connect to. By default using the default URL set in the config file (~/.impresso_py.yml) or the Impresso default URL ({DEFAULT_API_URL}).	`None`
`persisted_token`	`bool`	Whether to read and write token to the user directory (~/.impresso_py.yml). This is useful to avoid having to re-enter the token each time the Jupiter notebook is restarted.	`True`

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

License

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