semvec/pypi-packages huggingface dataset:
edinet-xbrl 0.2.0
A Python Edinet xbrl file parser
License: Apache License 2.0
Keywords: edinet xbrl parser for python

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

edinet_xbrl is a Python parser for Edinet xbrl files.


Installation
===============
.. Installation
   ------------

To install edinet_xbrl, simply:


.. code-block:: bash

  $ pip install edinet_xbrl

.. 


How To Use
===============
.. HowToUse
   ------------


To download xbrl files from EDINET:

.. code-block:: python

  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:

.. code-block:: python

  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()

..