Skip to content

franzmohr/esef

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

esef

esef is a package that can be used to download and -- in the future -- analyse ESEF data.

Package structure

The architecture of the package is based on a medallion data architecture.

  • Source: The standard data source of the package is https://filings.xbrl.org/.
  • Bronze: The bronze layer contains the report packages as zip-files.
  • Silver: Still under development. The plan is to save the data from xbrl files in a long format.
  • Gold: Still under development. The plan is to save the data from xbrl files in a wide format.

Data architecture.

Installation

The package is stil under development, but you can install the development version from source.

Install from Source (GitHub)

git clone https://github.com/franzmohr/esef.git
cd esef
pip install .

Usage

After installation, you can use esef to download data from https://filings.xbrl.org/.

Application 1: Downloading Report Packages

import esef

# Set root direcetory, where all the data should be stored
dl_folder = "/path/to/data/lake"

# Make sure all the neccessary (sub-)directories exist
esef.create_directory_tree(dl_folder)

# Get metadata on all the filings that are available for a country
filings = esef.available_filings("AT")

# Filter for a selected language
filings = filings.filter(lang = "de")

# Download the Report Packages
esef.download_report_package(dl_folder, filings)

Application 2:

Under development

About

Downloading and processing ESEF data

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages