Skip to content

Latest commit

 

History

History
204 lines (143 loc) · 6.26 KB

README.md

File metadata and controls

204 lines (143 loc) · 6.26 KB
Raw

Build Status


EDINETのXBRL情報で勘定項目を分析するためのツール(仮)

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

EDINETのXBRL情報で勘定項目を分析するためのツール バックエンドプロジェクト

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

簡単に環境構築するために以下3つの導入をお願いします

Installation

  1. リポジトリのクローン

    git clone https://github.com/Seibi0928/ResearchXBRL.git

  2. コンテナ環境構築

  • Devcontainerを使う場合

    • VSCodeを開く

      code ./ResearchXBRL

    • F1を押下しコマンドパレットを開く

    • Reopen in Containerと入力し選択

  • DevContainerを使わない場合

cd ResearchXBRL.Frontend
docker-compose -f ./devcontainer/docker-compose.yml up
  1. Usageのアプリケーションを上から順に起動する

(back to top)

Usage

有価証券報告書インポートバッチ

  • EDINETから有価証券報告書をダウンロードしDBへインポートするバッチ

  • 実行方法

dotnet run --project /src/Presentation/AquireFinancialReports/AquireFinancialReports.csproj

  • 任意で実行時引数を指定できます

    • --from

      • 取得する書類の提出日下限を指定します
      • 指定しない場合は24時間前の日時が指定されます
      • 5年以上前の日時を指定した場合エラーになります EDINETは直近5年のデータしか返さないため

    • --to

      • 取得する書類の提出日上限を指定します
      • 指定しない場合は現時刻が指定されます
      • 5年以上前の日時を指定した場合エラーになります EDINETは直近5年のデータしか返さないため

    • --max-parallelism

      • インポート処理の並列数を指定します
      • 指定しない場合は1が指定されます

  • 引数を使用したコマンドの一例

dotnet run --project /src/Presentation/AquireFinancialReports/AquireFinancialReports.csproj --from 2021-01-01 --to 2021-12-01 --max-parallelism 2

企業情報インポートバッチ

  • 企業情報をDBへインポートするバッチ

    • インポートするデータは/src/Presentation/ImportCorporationInfo/EdinetcodeDlInfo.csv
    • 上記データはタクソノミに含まれることが分かったので勘定項目インポートバッチバッチと統合予定

  • 実行方法

dotnet run --project /src/Presentation/ImportCorporationInfo/ImportCorporationInfo.csproj

勘定項目インポートバッチ

  • 勘定項目をダウンロードしDBへインポートするバッチ

    • 勘定項目はダウンロードしたタクソノミから抽出する

  • 実行方法

dotnet run --project /src/Presentation/AquireAccountItems/AquireAccountItems.csproj

勘定項目CSV出力バッチ

  • 入力したタクソノミデータから勘定項目を抽出し、勘定項目とXBRL特有の要素名の対応表csvを出力する
  • バッチを起動するとコンソールが立ち上がる
  • コンソールからスキーマファイルとラベルファイルのパスを指定する
dotnet run --project /src/Presentation/CreateAccountItemsCSV/CreateAccountItemsCSV.csproj

財務分析API

  • インポートしたデータをフロントエンドへ連携するためのAPI

  • 実行方法

dotnet run --project /src/Presentation/FinancialAnalysisAPI/FinancialAnalysisAPI.csproj
  • APIエンドポイント仕様(OpenAPI)
http://localhost:45613/swagger/v1/swagger.yaml

(back to top)

Contributing

歓迎

  1. プロジェクトをフォーク
  2. featureブランチ作成 (git checkout -b feature/AmazingFeature)
  3. 変更をコミット (git commit -m 'Add some AmazingFeature')
  4. ブランチをプッシュ (git push origin feature/AmazingFeature)
  5. developブランチへプルリク

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

ryo13579978@gmail.com

(back to top)