Metadata-Version: 2.1
Name: kueventparser
Version: 2.1.0
Summary: event parser of kyoto-univ.
Home-page: https://github.com/kkiyama117/KUEventParser
Author: kkiyama117
Author-email: k.kiyama117@gmail.com
Maintainer:  Unimap, Inc.
Maintainer-email: info@unimap.co.jp
License: MIT
Description: # event-parser
        イベント情報が載っているウェブページから情報を抽出し、特定のデータ形式に変換するパッケージ。
        
        ## Usage
        ### install
        ```bash
        # 任意のPython3.4以上の環境で構いません
        python -m venv .venv
        source venv/bin/activate
        # plz use setuptools 38 or newer version.
        pip install -U setuptools 
        ```
        `pip` を利用する場合(主にインストールした後バージョン管理をpipでしたい人向け)
        ```bash
        # by pip 
        pip install -e .
        ```
        `setuptools` を利用する場合(pipを利用しない場合)
        ```bash
        # by setuptools
        python setup.py install
        ```
        update や uninstall は各ツールのhelpを見るなどするか,
        詳細ドキュメント(下記)を見てください.
        
        ### run script
        ```bash
        parse_event [-h] [--help]
        ```
        
        ## Docs
        
        ### `get`
        ```python
        from kueventparser import get
        get(url="url of event")
        ```
        
        ### `get_all`
        ```python
        from kueventparser import get_all
        get_all()
        ```
        
        ### kueventparser
        ```python
        import kueventparser
        kueventparser.kueventparser('get_all', year=2019, month=2)
        ```
        
        `event`は指定URLのイベントページから抽出したイベント情報(`Event`)で、以下の構造になっている。
        ```python
        class Event:
            """イベント情報を含んだclass
            """
        
            def __init__(self, name:str, url: str, location: str, description: str, date: datetime.date,
                         start: datetime.time,
                         end: datetime.time):
                """イニシャライザー
                
                Args:
                    name: イベント名
                    url: イベント情報のURL
                    location: 開催地
                    description: 詳細説明文
                    date: 開催日
                    start: 開始時間
                    end: 終了時間
                """
        ```
        
        ### detail
        より正確なドキュメント群は[sphinx](http://www.sphinx-doc.org/ja/stable/index.html)で書かれている.
        
        ```bash
        # /docs/build/html/ にドキュメントが作成される.
        cd docs
        python make_docs.py
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: Japanese
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Topic :: Utilities
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Provides-Extra: test
