Skip to main content

A Python Edinet xbrl file parser

Project description

https://badge.fury.io/py/edinet-xbrl.svg https://travis-ci.org/BuffetCode/edinet_xbrl.svg?branch=master

edinet_xbrl is a Python parser for Edinet xbrl files.

Installation

To install edinet_xbrl, simply:

$ pip install edinet_xbrl

How To Use

To download xbrl files from EDINET:

from edinet_xbrl.edinet_xbrl_downloader import EdinetXbrlDownloader

## init downloader
xbrl_downloader = EdinetXbrlDownloader()

## set a ticker you want to download xbrl file
ticker = "1234"
target_dir = "a target directory path"
xbrl_downloader.download_by_ticker(ticker, target_dir)

To get value from your xbrl files:

from edinet_xbrl.edinet_xbrl_parser import EdinetXbrlParser

## init parser
parser = EdinetXbrlParser()

## parse xbrl file and get data container
xbrl_file_path = "set your xbrl file path"
edinet_xbrl_object = parser.parse_file(xbrl_file_path)

## get value from container
key = "jppfs_cor:Assets"
context_ref = "CurrentYearInstant"
current_year_assets = edinet_xbrl_object.get_data_by_context_ref(key, context_ref).get_value()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

edinet_xbrl-0.2.0.tar.gz (9.8 kB view details)

Uploaded Source

File details

Details for the file edinet_xbrl-0.2.0.tar.gz.

File metadata

  • Download URL: edinet_xbrl-0.2.0.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for edinet_xbrl-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c22be85fc54ce5df5fe457918b10acd839166dd4bc0595d26a2d1a007aa67043
MD5 5982c3ea1f27938361032d5c0765749d
BLAKE2b-256 48d31312a5d638ef614e4da1d2d97f85c8c08791152113c305b77709443ad273

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page