degiro-cli 0.1.0__tar.gz → 0.1.2__tar.gz

{degiro-cli-0.1.0/degiro_cli.egg-info → degiro-cli-0.1.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: degiro-cli
-Version: 0.1.0
-Summary: Command line tools for Degiro
+Version: 0.1.2
+Summary: Unofficial command line tools for Degiro
 Home-page: https://github.com/OhMajesticLama/degiro-cli
 Author-email: ohmajesticlama@gmail.com
 Project-URL: Documentation, https://ohmajesticlama.github.io/degiro-cli
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Provides-Extra: dev
 License-File: LICENSE
@@ -30,7 +31,7 @@ orders.
 ## Installation
 
 ``` sh
-pip3 install degirocli
+pip3 install degiro-cli
 ```
 
 ## Use
@@ -150,7 +151,7 @@ degiro-search --index 'EURO STOXX 50'
 
 ```
 
-## By Index
+## Get symbol history
 ``` sh
 degiro-history --period 1m EPA.SAF
 # exchange,symbol,date,currency,open,high,low,close

{degiro-cli-0.1.0 → degiro-cli-0.1.2}/README.md

@@ -13,7 +13,7 @@ orders.
 ## Installation
 
 ``` sh
-pip3 install degirocli
+pip3 install degiro-cli
 ```
 
 ## Use
@@ -133,7 +133,7 @@ degiro-search --index 'EURO STOXX 50'
 
 ```
 
-## By Index
+## Get symbol history
 ``` sh
 degiro-history --period 1m EPA.SAF
 # exchange,symbol,date,currency,open,high,low,close

{degiro-cli-0.1.0 → degiro-cli-0.1.2/degiro_cli.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: degiro-cli
-Version: 0.1.0
-Summary: Command line tools for Degiro
+Version: 0.1.2
+Summary: Unofficial command line tools for Degiro
 Home-page: https://github.com/OhMajesticLama/degiro-cli
 Author-email: ohmajesticlama@gmail.com
 Project-URL: Documentation, https://ohmajesticlama.github.io/degiro-cli
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Provides-Extra: dev
 License-File: LICENSE
@@ -30,7 +31,7 @@ orders.
 ## Installation
 
 ``` sh
-pip3 install degirocli
+pip3 install degiro-cli
 ```
 
 ## Use
@@ -150,7 +151,7 @@ degiro-search --index 'EURO STOXX 50'
 
 ```
 
-## By Index
+## Get symbol history
 ``` sh
 degiro-history --period 1m EPA.SAF
 # exchange,symbol,date,currency,open,high,low,close

{degiro-cli-0.1.0 → degiro-cli-0.1.2}/degiro_cli.egg-info/SOURCES.txt

@@ -11,4 +11,9 @@ degiro_cli.egg-info/PKG-INFO
 degiro_cli.egg-info/SOURCES.txt
 degiro_cli.egg-info/dependency_links.txt
 degiro_cli.egg-info/requires.txt
-degiro_cli.egg-info/top_level.txt
+degiro_cli.egg-info/top_level.txt
+degirocli/__init__.py
+degirocli/helpers.py
+degirocli/history.py
+degirocli/login.py
+degirocli/search.py

degiro-cli-0.1.2/degiro_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+degirocli

degiro-cli-0.1.2/degirocli/helpers.py

@@ -0,0 +1,61 @@
+import enum
+import logging
+import asyncio
+import collections
+from typing import Callable
+from typing import Iterable
+from typing import Any
+from typing import Sequence
+from typing import Union
+
+
+LOGGER = logging.getLogger('degirocli')
+
+class ERROR_CODES(enum.IntEnum):
+    SESSION_EXISTS = 1
+
+async def run_concurrent(
+        worker: Callable,
+        jobs: Iterable[Any],
+        *,
+        max_concurrents: int = 10,
+        ) -> Sequence[collections.abc.Awaitable]:
+    """
+    Run worker on jobs with a max of max_concurrents at the same time.
+
+    This is a helper to avoid sending too many queries at once to the producer
+    queried by worker.
+
+    >>> import asyncio
+    >>> async def worker(a, b):
+    ...     await asyncio.sleep(1)
+    ...     return a + b
+    ...
+    >>> awaitables = await run_concurrent(worker,
+    ...                             ((1, 2), (2, 3)))
+    ...
+    >>> res1 = await awaitables[0]
+    >>> res1
+    3
+
+    Arguments
+    ---------
+    
+    worker
+        Callable to apply to jobs.
+
+    jobs
+        Iterable of arguments that will be passed to worker.
+
+    max_concurrents
+        Maximum number of jobs that will be run concurrently.
+    """
+    LOGGER.debug('run_concurrent| worker %s', worker)
+    work_sem = asyncio.Semaphore(max_concurrents)
+
+    async def _wrapper(attrs):
+        async with work_sem:
+            res = await worker(*attrs)
+        return res
+
+    return [asyncio.create_task(_wrapper(attrs)) for attrs in jobs]

degiro-cli-0.1.2/degirocli/history.py

@@ -0,0 +1,200 @@
+import logging
+import argparse
+import io
+import sys
+import asyncio
+import csv
+from typing import Tuple, Iterable
+import getpass
+
+import more_itertools
+import degiroasync.api as dapi
+
+from .helpers import run_concurrent
+from .login import get_session_from_cache
+
+LOGGER = logging.getLogger()
+
+
+async def run_one(
+        session: dapi.Session,
+        exchange: str,
+        symbol: str,
+        period: dapi.PRICE.PERIOD
+        ):
+    """
+    """
+    try:
+        products = await dapi.search_product(
+                session,
+                by_symbol=symbol,
+                by_exchange=exchange,
+                product_type_id=dapi.PRODUCT.TYPEID.STOCK,
+                    )
+        if len(products) > 1:
+            raise AssertionError("More than one product for {}.{}".format(
+                symbol,
+                exchange))
+        elif len(products) == 0:
+            LOGGER.error(
+                    "No product found for exchange {}, symbol {}. Ignore.".format(
+                        exchange, symbol
+                    )
+            )
+            # Abort this one
+            return
+        product = products[0]
+        price_data: dapi.PriceSeriesTime = await dapi.get_price_data(
+                session,
+                product=product,
+                resolution=dapi.PRICE.RESOLUTION.PT1D,
+                period=period,
+                data_type=dapi.PRICE.TYPE.OHLC
+                )
+    except Exception as exc:
+        print(f"Error on symbol {exchange}.{symbol}: {exc}", file=sys.stderr)
+        return exc
+
+    writer = csv.writer(sys.stdout, delimiter=',')
+    writer.writerows(
+            (
+                exchange,
+                symbol,
+                date,
+                product.info.currency,
+                *price,
+            )
+
+            for date, price in zip(price_data.date, price_data.price)
+            )
+
+
+def prepare_inputs(input_stream: Iterable[str]) -> Iterable[Tuple[str, str]]:
+    """
+    Filter & split inputs from input_stream. Ignore lines starting with #
+
+    Example
+    -------
+
+        >>> inputs = ['EPA.AIR', 'EPA.BNP', ' #EPA.VIE']
+        >>> list(prepare_inputs(inputs))
+        [('EPA', 'AIR'), ('EPA', 'BNP')]
+
+    """
+    # filter-out lines starting with #
+    inputs = (line.strip() for line in input_stream)
+    inputs = filter(lambda l: len(l) > 0, inputs)
+    inputs = filter(lambda l: l[0] != '#', inputs)
+    inputs = more_itertools.unique_everseen(inputs)
+    inputs = (line.split('.')[:2] for line in inputs)
+    return inputs
+
+
+async def run(
+        session: dapi.Session, 
+        *,
+        symbols: Iterable[str],
+        period: dapi.PRICE.PERIOD = dapi.PRICE.PERIOD.P1YEAR,
+        max_workers: int = 5
+        ):
+    """
+    Execute script: read symbols from standard input and output fetched price
+    data on standard output.
+    """
+    inputs = prepare_inputs(symbols)
+    inputs = ((session, *t, period) for t in inputs)
+    #inputs = ((session, t) for t in inputs)
+
+    queries = await run_concurrent(run_one, inputs, max_concurrents=max_workers)
+
+    # ensure all queries completed before quitting
+    return await asyncio.gather(*queries)
+
+
+def run_cli():
+    handler = logging.StreamHandler()
+
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="Get history for provided symbols stocks. Symbols are read "
+                    "from standard input, and expected in format "
+                    "EXCHANGE.SYMBOL "
+                    "with EXCHANGE being product exchange on DEGIRO platform. "
+            )
+    parser.add_argument(
+            '-p', '--period',
+            default='1y',
+            dest='period',
+            help="Period on which to request data. Must be one of: "
+            "1d, 1m, 3m, 6m, 1y, 3y, 5y, 50y"
+            )
+    parser.add_argument(
+            '-H',
+            '--no-header-row',
+            dest='no_headers',
+            default=False,
+            action='store_true',
+            required=False,
+            help="Do not print header line"
+            )
+    parser.add_argument(
+            '--debug',
+            default=False,
+            action='store_true',
+            dest='debug',
+            help="Enable debug logging."
+            )
+    parser.add_argument(
+            'symbols',
+            nargs='*',
+            default=[],
+            help="Symbols should be in the form of EXCHANGE.PRODUCT_SYMBOL"
+            )
+    args = parser.parse_args()
+    logging_level = logging.ERROR
+    if args.debug:
+        logging_level = logging.DEBUG
+    handler.setLevel(logging_level)
+    LOGGER.setLevel(logging_level)
+    LOGGER.addHandler(handler)
+
+    print_headers = not args.no_headers
+
+    period = {
+        '1d': dapi.PRICE.PERIOD.P1DAY,
+        '1m': dapi.PRICE.PERIOD.P1MONTH,
+        '3m': dapi.PRICE.PERIOD.P3MONTH,
+        '6m': dapi.PRICE.PERIOD.P6MONTH,
+        '1y': dapi.PRICE.PERIOD.P1YEAR,
+        '3y': dapi.PRICE.PERIOD.P3YEAR,
+        '5y': dapi.PRICE.PERIOD.P5YEAR,
+        '50y': dapi.PRICE.PERIOD.P50YEAR
+            }[args.period.lower()]
+
+    session = get_session_from_cache()
+    session.update_throttling(max_requests=7, period_seconds=1)
+
+    symbols = sys.stdin
+    if len(args.symbols) > 0:
+        symbols = args.symbols
+
+    if print_headers:
+        writer = csv.writer(sys.stdout)
+        writer.writerow((
+            "exchange",
+            "symbol",
+            "date",
+            "currency",
+            "open",
+            "high",
+            "low",
+            "close",
+            ))
+    asyncio.get_event_loop().run_until_complete(
+            run(
+                session,
+                symbols=symbols,
+                period=period,
+                max_workers=5
+                )
+            )

degiro-cli-0.1.2/degirocli/login.py

@@ -0,0 +1,177 @@
+import tempfile
+import getpass
+import functools
+import multiprocessing
+import stat
+import asyncio
+import json
+import time
+import pickle
+import sys
+import os
+from pathlib import Path
+from typing import Union
+from typing import Optional
+
+import degiroasync.api as dapi
+import degiroasync.webapi as wapi
+import degiroasync.core as dcore
+
+from .helpers import ERROR_CODES
+from .helpers import LOGGER
+
+
+
+def get_credentials() -> dapi.Credentials:
+    """
+    Helper to get credentials for degiroasync provider.
+    """
+    DEGIRO_USERNAME = 'DEGIRO_USERNAME'
+    DEGIRO_PASSWORD = 'DEGIRO_PASSWORD'
+    DEGIRO_TOTP_SECRET = 'DEGIRO_TOTP_SECRET'
+    if (username := os.environ.get(DEGIRO_USERNAME)) is None:
+        username = input('Username: ')
+        if len(username.strip()) == 0:
+            raise AssertionError(
+                    "{} not set and not provided".format(DEGIRO_USERNAME))
+    if (password := os.environ.get(DEGIRO_PASSWORD)) is None:
+        password = getpass.getpass('Password: ')
+        if len(password.strip()) == 0:
+            raise AssertionError("{} not set and not provided".format(DEGIRO_PASSWORD))
+    totp_secret: Optional[str] = os.environ.get(DEGIRO_TOTP_SECRET) or None  # could be ''
+    totp = None
+    if totp_secret is None:
+        # Ask user for TOTP
+        totp: Optional[str] = input("One Time Password (Enter to ignore): ")
+        if len(totp.strip()) == 0:
+            totp = None
+
+    return dapi.Credentials(
+        username=username,
+        password=password,
+        totp_secret=totp_secret,
+        one_time_password=totp
+        )
+
+
+def get_tmp_path():
+    tmpdir = Path(tempfile.gettempdir())
+    return tmpdir / 'degirocli' 
+
+def _get_hash(path: Union[Path, str]) -> str:
+    with open(path, 'rb') as fh:
+        fhash = hash(fh)
+    return fhash
+
+
+def expire_path(
+        path: Union[Path, str],
+        lifetime_seconds: Union[int, float]=60*60*2,
+        start_time_seconds: Optional[Union[int, float]] = None,
+        force: bool = False,
+        ):
+    """
+    Will remove file at path after 'lifetime_seconds'.
+
+    Parameters
+    ----------
+
+    path
+        Path to remove when expired. By default, `path` will only be removed
+        if it hasn't changed since watcher started. 
+
+    lifetime_seconds
+        File at path will be expired at start_time_seconds + lifetime_seconds.
+
+    start_time_seconds
+        File at path will be expired at start_time_seconds + lifetime_seconds.
+        Defaults to time.time().
+
+    force
+        If true, file at `path` will be removed even if it has changed since
+        this function has been called.
+    """
+    # Let's detach this process.
+    if os.fork() != 0:  # If os.fork == 0 this is the detached process.
+        return
+    if not isinstance(path, Path):
+        assert isinstance(path, str)
+        path = Path(path)
+    fhash = _get_hash(path)
+    start_time_seconds = start_time_seconds or time.time()
+
+    while time.time() - start_time_seconds < lifetime_seconds:
+        time.sleep(time.time() - start_time_seconds)
+
+    tmp_path = get_tmp_path()
+    if tmp_path.exists():
+        if tmp_path.is_file():
+            fhash_new = _get_hash(path)
+            if fhash_new == fhash or force:
+                Path.unlink(tmp_path)
+            else:
+                print(f'{path} has changed since it has been set to expire. '
+                      f'Abort deletion.', file=sys.stderr)
+                return 1
+    return 0
+
+
+#@functools.wraps(_expire_path)
+#def expire_path(*args):
+#    # Start event loop to 
+#    proc = multiprocessing.Process(
+#            target=_expire_path,
+#            args=args,
+#            daemon=False)
+#    proc.start()
+
+
+async def login():
+    tmp_path = get_tmp_path()
+
+    if tmp_path.exists():
+        ans = input("Existing session found, delete? (y/N)").strip().lower()
+        if ans in ('y', 'yes'):
+            tmp_path.unlink()
+        else:
+            print('Abort.')
+            return ERROR_CODES.SESSION_EXISTS
+
+    # Get sessionID and write it
+    credentials = get_credentials()
+    session = await wapi.login(credentials)
+    tmp_path.touch()
+    tmp_path.chmod(stat.S_IRUSR | stat.S_IWUSR)
+    with open(tmp_path, 'w') as fh:
+        json.dump({
+            'version': 1,
+            'format': 'degirocli',
+            'session': dict(
+                cookies=session.cookies,
+                ),
+            }, fh)
+    # Delete file in 3 hour
+    expire_path(tmp_path, 3*60*60)
+
+async def _get_session_from_cache() -> dapi.Session:
+    cache_path = get_tmp_path()
+    if not cache_path.exists():
+        raise AssertionError(
+                f"{cache_path} not found. Abort. Have you tried degiro-login?")
+    with open(cache_path, 'r') as fh:
+        session_d = json.load(fh)
+    session = dcore.SessionCore()
+    session._cookies = session_d['session']['cookies']
+    await wapi.get_config(session)
+    await wapi.get_client_info(session)
+    exc_dict = await dapi.get_dictionary(session)
+    return dapi.Session(session, exc_dict)
+
+def get_session_from_cache() -> dapi.Session:
+    """
+    Helper to get Session when already logged in.
+    """
+    return asyncio.get_event_loop().run_until_complete(_get_session_from_cache())
+
+def  run_cli():
+    asyncio.get_event_loop().run_until_complete(login())

degiro-cli-0.1.2/degirocli/search.py

@@ -0,0 +1,174 @@
+import sys
+import asyncio
+import logging
+import argparse
+import csv
+from typing import Optional
+
+import degiroasync.api as dapi
+
+from .helpers import LOGGER
+from .login import get_session_from_cache
+
+
+async def run(
+        session: dapi.Session, 
+        *,
+        search_txt: Optional[str],
+        exchange_txt: Optional[str],
+        country_txt: Optional[str],
+        index_txt: Optional[str]
+        ):
+    """
+    Execute script: read symbols from standard input and output fetched price
+    data on standard output.
+    """
+    exc_dict = session.dictionary
+    products = await dapi.search_product(
+        session=session,
+        by_text=search_txt,
+        by_exchange=exchange_txt,
+        by_country=country_txt,
+        by_index=index_txt,
+            )
+    writer = csv.writer(sys.stdout)
+    exc_dict: dapi.ExchangeDictionary = session.dictionary
+    for product in products:
+        exchange = exc_dict.exchange_by(id=product.info.exchange_id)
+        writer.writerow((
+                exchange.hiq_abbr,
+                product.info.symbol,
+                product.info.name,
+                product.info.currency,
+                product.info.isin,
+                ))
+
+
+
+def run_cli():
+    handler = logging.StreamHandler()
+
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="Get history for provided symbols stocks. Symbols are read "
+                    "from standard input, and expected in format "
+                    "EXCHANGE.SYMBOL "
+                    "with EXCHANGE being product exchange on DEGIRO platform. "
+            )
+    parser.add_argument(
+            '-t',
+            dest='search',
+            default=None,
+            required=False,
+            help="Search for SEARCH_TXT and returns products."
+            )
+    parser.add_argument(
+            '--exchange',
+            dest='exchange',
+            default=None,
+            required=False,
+            help="Search for products by exchange."
+            )
+    parser.add_argument(
+            '--country',
+            dest='country',
+            default=None,
+            required=False,
+            help="Search products on exchange places in COUNTRY"
+            )
+    parser.add_argument(
+            '--list-countries',
+            dest='list_countries',
+            default=False,
+            action='store_true',
+            required=False,
+            help="Print the available country codes on the platform."
+            )
+    parser.add_argument(
+            '--index',
+            dest='index',
+            default=None,
+            required=False,
+            help="Search products on exchange places in INDEX"
+            )
+    parser.add_argument(
+            '--list-indices',
+            dest='list_indices',
+            default=False,
+            action='store_true',
+            required=False,
+            help="Print the available incides codes on the platform."
+            )
+    parser.add_argument(
+            '-H',
+            '--no-header-row',
+            dest='no_headers',
+            default=False,
+            action='store_true',
+            required=False,
+            help="Do not print header line"
+            )
+    parser.add_argument(
+            '--debug',
+            default=False,
+            action='store_true',
+            dest='debug',
+            help="Enable debug logging."
+            )
+    args = parser.parse_args()
+    
+    print_headers = not args.no_headers
+    search_txt = args.search
+    exchange_txt = args.exchange
+    country_txt = args.country
+    index_txt = args.index
+    list_indices = args.list_indices
+
+    logging_level = logging.ERROR
+    if args.debug:
+        logging_level = logging.DEBUG
+    handler.setLevel(logging_level)
+    LOGGER.setLevel(logging_level)
+    LOGGER.addHandler(handler)
+
+    session = get_session_from_cache()
+    # Lower throttling limit here as there is a good chance we'll
+    # bigger period limits: it seems degiro sends browser checks
+    # after many requests have been issued.
+    session.update_throttling(max_requests=10, period_seconds=1)
+
+    if args.list_countries:
+        for country in sorted(
+                session.dictionary.countries,
+                key=lambda x: x.name):
+            print(country.name)
+        return 0
+    if args.list_indices:
+        for index in sorted(
+                session.dictionary.indices,
+                key=lambda x: x.name):
+            if index.product_id is not None:
+                # 202307
+                # There is currently no support to pull products from an index
+                # where product_id not set by the platform, so don't show them.
+                print(index.name)
+        return 0
+
+    if print_headers:
+        writer = csv.writer(sys.stdout)
+        writer.writerow((
+            "exchange",
+            "symbol",
+            "name",
+            "currency",
+            "isin",
+            ))
+    asyncio.get_event_loop().run_until_complete(
+            run(
+                session,
+                search_txt=search_txt,
+                exchange_txt=exchange_txt,
+                country_txt=country_txt,
+                index_txt=index_txt
+                )
+            )

{degiro-cli-0.1.0 → degiro-cli-0.1.2}/setup.py

@@ -8,14 +8,14 @@ import setuptools
 
 
 if __name__ == '__main__':
-    description = "Command line tools for Degiro"
+    description = "Unofficial command line tools for Degiro"
     readme_path = os.path.join(os.path.dirname(__file__), 'README.md')
     with open(readme_path, "r") as fh:
         long_description = fh.read()
 
     setuptools.setup(
         name="degiro-cli",
-        version="0.1.0",
+        version="0.1.2",
         author_email="ohmajesticlama@gmail.com",
         description=description,
         long_description=long_description,
@@ -31,6 +31,7 @@ if __name__ == '__main__':
             os.path.join('bin', 'degiro-history'),
             os.path.join('bin', 'degiro-search'),
             ],
+        python_requires=">=3.8",
         install_requires=[
             'degiroasync >= 0.20.0',
             ],

degiro-cli-0.1.0/degiro_cli.egg-info/top_level.txt

@@ -1 +0,0 @@
-