dart-fss


Namedart-fss JSON
Version 0.4.10 PyPI version JSON
download
home_pageNone
SummaryWeb-scraping https://dart.fss.or.kr
upload_time2024-03-27 13:45:21
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT
keywords fss dart-fss scrapping financial_statement
VCS
bugtrack_url
requirements xmltodict requests arelle-release numpy pandas tqdm yaspin fake-useragent beautifulsoup4 appdirs
Travis-CI No Travis.
coveralls test coverage
            # Dart-Fss
[![PyPI](https://img.shields.io/pypi/v/dart-fss.svg)](https://pypi.org/project/dart-fss/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dart-fss.svg)
![Build Status](https://bit.ly/3fufevG)
[![Coverage](https://codecov.io/gh/josw123/dart-fss/branch/master/graphs/badge.svg)](https://codecov.io/gh/josw123/dart-fss)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7ebb506ba99d4a22b2bbcda2d85b3bde)](https://www.codacy.com/app/josw123/dart-fss?utm_source=github.com&utm_medium=referral&utm_content=josw123/dart-fss&utm_campaign=Badge_Grade)

대한민국 금융감독원에서 운영하는 다트([DART](https://dart.fss.or.kr)) 사이트 크롤링 및 재무제표 추출을 위한 라이브러리

- Source code: https://github.com/josw123/dart-fss

## Features

-   [Open DART](https://opendart.fss.or.kr/)의 오픈 API를 이용한 전자공시 조회
-   [DART](https://dart.fss.or.kr)의 전자공시 정보를 이용한 재무제표 추출

## Installation

- Open DART 지원 / 신규 Open DART API Key 필요
- Python 3.7 이상 지원
- Documentation: https://dart-fss.readthedocs.io/

``` bash
pip install -U dart-fss
```

## Usage

### Dart API Key 설정

-  [OPEN DART API 신청](https://opendart.fss.or.kr/)
-  환경 변수 DART_API_KEY 설정 또는 패키지 사용전 아래와 같이 설정

### Quick Starts

```python
import dart_fss as dart

# Open DART API KEY 설정
api_key='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
dart.set_api_key(api_key=api_key)

# DART 에 공시된 회사 리스트 불러오기
corp_list = dart.get_corp_list()

# 삼성전자 검색
samsung = corp_list.find_by_corp_name('삼성전자', exactly=True)[0]

# 2012년부터 연간 연결재무제표 불러오기
fs = samsung.extract_fs(bgn_de='20120101')

# 재무제표 검색 결과를 엑셀파일로 저장 ( 기본저장위치: 실행폴더/fsdata )
fs.save()
```

## 주의사항

-   Open DART 및 DART 홈페이지의 경우 분당 1000회 이상 요청시 서비스가 제한될 수 있음
-   [관련 공지사항](https://bit.ly/3cjF3Np): [FAQ]->[오픈API 이용한도는 어떻게 되나요?]

## License
This project is licensed under the MIT License

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dart-fss",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Sungwoo Jo <nonswing.z@gmail.com>",
    "keywords": "fss, dart-fss, scrapping, financial_statement",
    "author": null,
    "author_email": "Sungwoo Jo <nonswing.z@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/63/23/f6c0e5ca8fd874736a28870b40c19be6cdcadf095b5aace17d8030851cf3/dart-fss-0.4.10.tar.gz",
    "platform": null,
    "description": "# Dart-Fss\n[![PyPI](https://img.shields.io/pypi/v/dart-fss.svg)](https://pypi.org/project/dart-fss/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dart-fss.svg)\n![Build Status](https://bit.ly/3fufevG)\n[![Coverage](https://codecov.io/gh/josw123/dart-fss/branch/master/graphs/badge.svg)](https://codecov.io/gh/josw123/dart-fss)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7ebb506ba99d4a22b2bbcda2d85b3bde)](https://www.codacy.com/app/josw123/dart-fss?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=josw123/dart-fss&amp;utm_campaign=Badge_Grade)\n\n\ub300\ud55c\ubbfc\uad6d \uae08\uc735\uac10\ub3c5\uc6d0\uc5d0\uc11c \uc6b4\uc601\ud558\ub294 \ub2e4\ud2b8([DART](https://dart.fss.or.kr)) \uc0ac\uc774\ud2b8 \ud06c\ub864\ub9c1 \ubc0f \uc7ac\ubb34\uc81c\ud45c \ucd94\ucd9c\uc744 \uc704\ud55c \ub77c\uc774\ube0c\ub7ec\ub9ac\n\n- Source code: https://github.com/josw123/dart-fss\n\n## Features\n\n-   [Open DART](https://opendart.fss.or.kr/)\uc758 \uc624\ud508 API\ub97c \uc774\uc6a9\ud55c \uc804\uc790\uacf5\uc2dc \uc870\ud68c\n-   [DART](https://dart.fss.or.kr)\uc758 \uc804\uc790\uacf5\uc2dc \uc815\ubcf4\ub97c \uc774\uc6a9\ud55c \uc7ac\ubb34\uc81c\ud45c \ucd94\ucd9c\n\n## Installation\n\n- Open DART \uc9c0\uc6d0 / \uc2e0\uaddc Open DART API Key \ud544\uc694\n- Python 3.7 \uc774\uc0c1 \uc9c0\uc6d0\n- Documentation: https://dart-fss.readthedocs.io/\n\n``` bash\npip install -U dart-fss\n```\n\n## Usage\n\n### Dart API Key \uc124\uc815\n\n-  [OPEN DART API \uc2e0\uccad](https://opendart.fss.or.kr/)\n-  \ud658\uacbd \ubcc0\uc218 DART_API_KEY \uc124\uc815 \ub610\ub294 \ud328\ud0a4\uc9c0 \uc0ac\uc6a9\uc804 \uc544\ub798\uc640 \uac19\uc774 \uc124\uc815\n\n### Quick Starts\n\n```python\nimport dart_fss as dart\n\n# Open DART API KEY \uc124\uc815\napi_key='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\ndart.set_api_key(api_key=api_key)\n\n# DART \uc5d0 \uacf5\uc2dc\ub41c \ud68c\uc0ac \ub9ac\uc2a4\ud2b8 \ubd88\ub7ec\uc624\uae30\ncorp_list = dart.get_corp_list()\n\n# \uc0bc\uc131\uc804\uc790 \uac80\uc0c9\nsamsung = corp_list.find_by_corp_name('\uc0bc\uc131\uc804\uc790', exactly=True)[0]\n\n# 2012\ub144\ubd80\ud130 \uc5f0\uac04 \uc5f0\uacb0\uc7ac\ubb34\uc81c\ud45c \ubd88\ub7ec\uc624\uae30\nfs = samsung.extract_fs(bgn_de='20120101')\n\n# \uc7ac\ubb34\uc81c\ud45c \uac80\uc0c9 \uacb0\uacfc\ub97c \uc5d1\uc140\ud30c\uc77c\ub85c \uc800\uc7a5 ( \uae30\ubcf8\uc800\uc7a5\uc704\uce58: \uc2e4\ud589\ud3f4\ub354/fsdata )\nfs.save()\n```\n\n## \uc8fc\uc758\uc0ac\ud56d\n\n-   Open DART \ubc0f DART \ud648\ud398\uc774\uc9c0\uc758 \uacbd\uc6b0 \ubd84\ub2f9 1000\ud68c \uc774\uc0c1 \uc694\uccad\uc2dc \uc11c\ube44\uc2a4\uac00 \uc81c\ud55c\ub420 \uc218 \uc788\uc74c\n-   [\uad00\ub828 \uacf5\uc9c0\uc0ac\ud56d](https://bit.ly/3cjF3Np): [FAQ]->[\uc624\ud508API \uc774\uc6a9\ud55c\ub3c4\ub294 \uc5b4\ub5bb\uac8c \ub418\ub098\uc694?]\n\n## License\nThis project is licensed under the MIT License\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Web-scraping https://dart.fss.or.kr",
    "version": "0.4.10",
    "project_urls": {
        "documentation": "https://dart-fss.readthedocs.io/",
        "homepage": "https://github.com/josw123/dart-fss",
        "repository": "https://github.com/josw123/dart-fss.git"
    },
    "split_keywords": [
        "fss",
        " dart-fss",
        " scrapping",
        " financial_statement"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8a4020df8c709d63bf8280972bc427db3813279e0e247dd810225ea7f1916650",
                "md5": "991ab2ba694793c55514f0c00c333cc4",
                "sha256": "de8c726947001d8e0d29783199a4de74e3350f1d8012d9b94ef0a70b8ade9dc7"
            },
            "downloads": -1,
            "filename": "dart_fss-0.4.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "991ab2ba694793c55514f0c00c333cc4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 145685,
            "upload_time": "2024-03-27T13:45:19",
            "upload_time_iso_8601": "2024-03-27T13:45:19.535279Z",
            "url": "https://files.pythonhosted.org/packages/8a/40/20df8c709d63bf8280972bc427db3813279e0e247dd810225ea7f1916650/dart_fss-0.4.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6323f6c0e5ca8fd874736a28870b40c19be6cdcadf095b5aace17d8030851cf3",
                "md5": "700786176e618d8108277b4f22ed9a54",
                "sha256": "d69def0365ab0e4befcf9a1b36a1e3d8849cb6ce8ffbd1b160632dc50ae5490a"
            },
            "downloads": -1,
            "filename": "dart-fss-0.4.10.tar.gz",
            "has_sig": false,
            "md5_digest": "700786176e618d8108277b4f22ed9a54",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 90625,
            "upload_time": "2024-03-27T13:45:21",
            "upload_time_iso_8601": "2024-03-27T13:45:21.874118Z",
            "url": "https://files.pythonhosted.org/packages/63/23/f6c0e5ca8fd874736a28870b40c19be6cdcadf095b5aace17d8030851cf3/dart-fss-0.4.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-27 13:45:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "josw123",
    "github_project": "dart-fss",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "requirements": [
        {
            "name": "xmltodict",
            "specs": []
        },
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "arelle-release",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "pandas",
            "specs": []
        },
        {
            "name": "tqdm",
            "specs": []
        },
        {
            "name": "yaspin",
            "specs": []
        },
        {
            "name": "fake-useragent",
            "specs": [
                [
                    ">=",
                    "1.5"
                ]
            ]
        },
        {
            "name": "beautifulsoup4",
            "specs": []
        },
        {
            "name": "appdirs",
            "specs": []
        }
    ],
    "lcname": "dart-fss"
}
        
Elapsed time: 0.22622s