Archivist: Application for archiving API responses based on the Textual framework

Introduction

A simple application that uses RestAPI to access servers at regular intervals. The received data is written or added to json/csv/html files.

Installation

1. For all Python-enabled operating systems

1. Clone repo.
2. In workdir: pip install -r requirements.txt
3. in console run: python ./src/app.py

2. The Windows executable file is located in the dist folder in the *.zip archive
3. To deploy a service using Docker, there are Dockerfile and docker-compose.yaml files in the working directory.

Tasks

Json fields description

1. name: task name
2. comment: task comment
3. request_method: HTTP-method, GET or POST
4. request_url: server url
5. request_headers: request header (for POST requests)
6. request_body: request body (for POST requests)
7. file_format: the file format for writing data (json or csv or html)
8. interval: time interval (1min/5min/10min/30min/60min/1day)
9. file_save_mode: data recording mode (rewrite or append)
10. json_key: if specified, only the key values are saved
11. status: task status (filled in by the application itself)

Settings

Json fields description

1. data_folder: Folder for writing data files. By default, writing goes to the current folder in the data directory (if the value is ".")

License

This project is licensed under the GPL-3.0 License.