degiro-cli 0.1.3__tar.gz → 0.1.4__tar.gz

{degiro_cli-0.1.3 → degiro_cli-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: degiro-cli
-Version: 0.1.3
+Version: 0.1.4
 Summary: Unofficial command line tools for Degiro
 Author-email: ohmajesticlama <ohmajesticlama@gmail.com>
 License: MIT
@@ -16,7 +16,7 @@ Classifier: Topic :: Office/Business :: Financial :: Investment
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: degiroasync>=1.0.0
+Requires-Dist: degiroasync>=1.1.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.1; extra == "dev"
 Requires-Dist: coverage>=6.3; extra == "dev"
@@ -35,8 +35,7 @@ Dynamic: license-file
 
 ## Introduction
 
-Command line tools for DEGIRO platform. It's primary purpose at this date
-is to:
+Command line tools for DEGIRO platform. Primary features:
 - Search for STOCK products by various criteria.
 - Access STOCK products history.
 
@@ -46,7 +45,11 @@ orders.
 ## Installation
 
 ``` sh
-pip3 install degiro-cli
+# With [uv](https://docs.astral.sh/uv/) (recommended)
+uv tool install degiro-cli
+
+# With pip
+pip3 install -u degiro-cli
 ```
 
 ## Use
@@ -55,7 +58,7 @@ manipulation tools such as [CSV Kit](https://csvkit.rtfd.org/). Especially
 the `csvlook` command if you intend to just visualize outputes from command
 line.
 
-## Login
+### Login
 
 ``` sh
 # Only the session id is stored, that means a new login will be required
@@ -63,6 +66,25 @@ line.
 degiro-login
 ```
 
+### Get portfolio
+```sh
+degiro-portfolio
+# Output:
+# position_type,exchange,isin,name,currency,size,price,value
+# PRODUCT,EPA,FR0000121972,Schneider Electric SE,EUR,10,276.05,2760
+# PRODUCT,SCG,DE000CL5C2Q2,SG Airbus Turbo illimités Call BAR 37.08 STR 35.6901 P 10 LV 1.23,EUR,100,15.635,1563.50
+# CASH,N/A,EUR,EUR,EUR,3000.00,1,3000.00
+
+# With csvlook formatting
+degiro-portfolio  | csvlook --max-column-width 30
+# Output:
+# | position_type | exchange | isin         | name                           | currency |     size |   price |     value |
+# | ------------- | -------- | ------------ | ------------------------------ | -------- | -------- | ------- | --------- |
+# | PRODUCT       | EPA      | FR0000121972 | Schneider Electric SE          | EUR      |    10,00 | 276,050 |  2 760,00 |
+# | PRODUCT       | SCG      | DE000CL5C2Q2 | SG Airbus Turbo illimités C... | EUR      |   100,00 |  15,635 |  1 563,50 |
+# | CASH          |          | EUR          | EUR                            | EUR      | 3 000,00 |   1,000 |  3 000,00 |
+```
+
 ### Find products
 
 ``` sh
@@ -91,7 +113,7 @@ degiro-search -t airbus | csvlook
 # | FRA      | AIRA   | Airbus SE | EUR      | US0092791005 |
 ```
 
-## List countries available on the platform
+### List countries available on the platform
 ``` sh
 # List country codes available on the platform
 degiro-search --list-countries
@@ -125,7 +147,7 @@ degiro-search --list-countries
 #   US
 ```
 
-## By Index
+### By Index
 ``` sh
 # List country codes available on the platform
 degiro-search --list-indices
@@ -166,7 +188,7 @@ degiro-search --index 'EURO STOXX 50'
 
 ```
 
-## Get symbol history
+### Get symbol history
 ``` sh
 degiro-history --period 1m EPA.SAF
 # exchange,symbol,date,currency,open,high,low,close
@@ -221,11 +243,14 @@ degiro-history --period 1m EPA.SAF | csvlook
 
 ```
 
-## Global Examples
+### Chain with other tools
 
+degiro-cli can be chained with other command line tools to achieve more complex processing.
 ``` sh
+degiro-login
 # Example command line to pull history for all stocks in a country with
 # the help of the great CLI tool csvkit
-country=NL; degiro-search --country $country --no-header-row |  csvcut -c 1-2  | sed 's/,/./'  | xargs -n 100 degiro-history -p 5y | tee -a prices.$country.csv
+countr="NL"; degiro-search --country "$country" --no-header-row |  csvcut -c 1-2  | sed 's/,/./'  | xargs -n 100 degiro-history -p 5y | tee -a prices.$country.csv
 ```
 
+

{degiro_cli-0.1.3 → degiro_cli-0.1.4}/README.md

@@ -2,8 +2,7 @@
 
 ## Introduction
 
-Command line tools for DEGIRO platform. It's primary purpose at this date
-is to:
+Command line tools for DEGIRO platform. Primary features:
 - Search for STOCK products by various criteria.
 - Access STOCK products history.
 
@@ -13,7 +12,11 @@ orders.
 ## Installation
 
 ``` sh
-pip3 install degiro-cli
+# With [uv](https://docs.astral.sh/uv/) (recommended)
+uv tool install degiro-cli
+
+# With pip
+pip3 install -u degiro-cli
 ```
 
 ## Use
@@ -22,7 +25,7 @@ manipulation tools such as [CSV Kit](https://csvkit.rtfd.org/). Especially
 the `csvlook` command if you intend to just visualize outputes from command
 line.
 
-## Login
+### Login
 
 ``` sh
 # Only the session id is stored, that means a new login will be required
@@ -30,6 +33,25 @@ line.
 degiro-login
 ```
 
+### Get portfolio
+```sh
+degiro-portfolio
+# Output:
+# position_type,exchange,isin,name,currency,size,price,value
+# PRODUCT,EPA,FR0000121972,Schneider Electric SE,EUR,10,276.05,2760
+# PRODUCT,SCG,DE000CL5C2Q2,SG Airbus Turbo illimités Call BAR 37.08 STR 35.6901 P 10 LV 1.23,EUR,100,15.635,1563.50
+# CASH,N/A,EUR,EUR,EUR,3000.00,1,3000.00
+
+# With csvlook formatting
+degiro-portfolio  | csvlook --max-column-width 30
+# Output:
+# | position_type | exchange | isin         | name                           | currency |     size |   price |     value |
+# | ------------- | -------- | ------------ | ------------------------------ | -------- | -------- | ------- | --------- |
+# | PRODUCT       | EPA      | FR0000121972 | Schneider Electric SE          | EUR      |    10,00 | 276,050 |  2 760,00 |
+# | PRODUCT       | SCG      | DE000CL5C2Q2 | SG Airbus Turbo illimités C... | EUR      |   100,00 |  15,635 |  1 563,50 |
+# | CASH          |          | EUR          | EUR                            | EUR      | 3 000,00 |   1,000 |  3 000,00 |
+```
+
 ### Find products
 
 ``` sh
@@ -58,7 +80,7 @@ degiro-search -t airbus | csvlook
 # | FRA      | AIRA   | Airbus SE | EUR      | US0092791005 |
 ```
 
-## List countries available on the platform
+### List countries available on the platform
 ``` sh
 # List country codes available on the platform
 degiro-search --list-countries
@@ -92,7 +114,7 @@ degiro-search --list-countries
 #   US
 ```
 
-## By Index
+### By Index
 ``` sh
 # List country codes available on the platform
 degiro-search --list-indices
@@ -133,7 +155,7 @@ degiro-search --index 'EURO STOXX 50'
 
 ```
 
-## Get symbol history
+### Get symbol history
 ``` sh
 degiro-history --period 1m EPA.SAF
 # exchange,symbol,date,currency,open,high,low,close
@@ -188,11 +210,14 @@ degiro-history --period 1m EPA.SAF | csvlook
 
 ```
 
-## Global Examples
+### Chain with other tools
 
+degiro-cli can be chained with other command line tools to achieve more complex processing.
 ``` sh
+degiro-login
 # Example command line to pull history for all stocks in a country with
 # the help of the great CLI tool csvkit
-country=NL; degiro-search --country $country --no-header-row |  csvcut -c 1-2  | sed 's/,/./'  | xargs -n 100 degiro-history -p 5y | tee -a prices.$country.csv
+countr="NL"; degiro-search --country "$country" --no-header-row |  csvcut -c 1-2  | sed 's/,/./'  | xargs -n 100 degiro-history -p 5y | tee -a prices.$country.csv
 ```
 
+

{degiro_cli-0.1.3 → degiro_cli-0.1.4}/degiro_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: degiro-cli
-Version: 0.1.3
+Version: 0.1.4
 Summary: Unofficial command line tools for Degiro
 Author-email: ohmajesticlama <ohmajesticlama@gmail.com>
 License: MIT
@@ -16,7 +16,7 @@ Classifier: Topic :: Office/Business :: Financial :: Investment
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: degiroasync>=1.0.0
+Requires-Dist: degiroasync>=1.1.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.1; extra == "dev"
 Requires-Dist: coverage>=6.3; extra == "dev"
@@ -35,8 +35,7 @@ Dynamic: license-file
 
 ## Introduction
 
-Command line tools for DEGIRO platform. It's primary purpose at this date
-is to:
+Command line tools for DEGIRO platform. Primary features:
 - Search for STOCK products by various criteria.
 - Access STOCK products history.
 
@@ -46,7 +45,11 @@ orders.
 ## Installation
 
 ``` sh
-pip3 install degiro-cli
+# With [uv](https://docs.astral.sh/uv/) (recommended)
+uv tool install degiro-cli
+
+# With pip
+pip3 install -u degiro-cli
 ```
 
 ## Use
@@ -55,7 +58,7 @@ manipulation tools such as [CSV Kit](https://csvkit.rtfd.org/). Especially
 the `csvlook` command if you intend to just visualize outputes from command
 line.
 
-## Login
+### Login
 
 ``` sh
 # Only the session id is stored, that means a new login will be required
@@ -63,6 +66,25 @@ line.
 degiro-login
 ```
 
+### Get portfolio
+```sh
+degiro-portfolio
+# Output:
+# position_type,exchange,isin,name,currency,size,price,value
+# PRODUCT,EPA,FR0000121972,Schneider Electric SE,EUR,10,276.05,2760
+# PRODUCT,SCG,DE000CL5C2Q2,SG Airbus Turbo illimités Call BAR 37.08 STR 35.6901 P 10 LV 1.23,EUR,100,15.635,1563.50
+# CASH,N/A,EUR,EUR,EUR,3000.00,1,3000.00
+
+# With csvlook formatting
+degiro-portfolio  | csvlook --max-column-width 30
+# Output:
+# | position_type | exchange | isin         | name                           | currency |     size |   price |     value |
+# | ------------- | -------- | ------------ | ------------------------------ | -------- | -------- | ------- | --------- |
+# | PRODUCT       | EPA      | FR0000121972 | Schneider Electric SE          | EUR      |    10,00 | 276,050 |  2 760,00 |
+# | PRODUCT       | SCG      | DE000CL5C2Q2 | SG Airbus Turbo illimités C... | EUR      |   100,00 |  15,635 |  1 563,50 |
+# | CASH          |          | EUR          | EUR                            | EUR      | 3 000,00 |   1,000 |  3 000,00 |
+```
+
 ### Find products
 
 ``` sh
@@ -91,7 +113,7 @@ degiro-search -t airbus | csvlook
 # | FRA      | AIRA   | Airbus SE | EUR      | US0092791005 |
 ```
 
-## List countries available on the platform
+### List countries available on the platform
 ``` sh
 # List country codes available on the platform
 degiro-search --list-countries
@@ -125,7 +147,7 @@ degiro-search --list-countries
 #   US
 ```
 
-## By Index
+### By Index
 ``` sh
 # List country codes available on the platform
 degiro-search --list-indices
@@ -166,7 +188,7 @@ degiro-search --index 'EURO STOXX 50'
 
 ```
 
-## Get symbol history
+### Get symbol history
 ``` sh
 degiro-history --period 1m EPA.SAF
 # exchange,symbol,date,currency,open,high,low,close
@@ -221,11 +243,14 @@ degiro-history --period 1m EPA.SAF | csvlook
 
 ```
 
-## Global Examples
+### Chain with other tools
 
+degiro-cli can be chained with other command line tools to achieve more complex processing.
 ``` sh
+degiro-login
 # Example command line to pull history for all stocks in a country with
 # the help of the great CLI tool csvkit
-country=NL; degiro-search --country $country --no-header-row |  csvcut -c 1-2  | sed 's/,/./'  | xargs -n 100 degiro-history -p 5y | tee -a prices.$country.csv
+countr="NL"; degiro-search --country "$country" --no-header-row |  csvcut -c 1-2  | sed 's/,/./'  | xargs -n 100 degiro-history -p 5y | tee -a prices.$country.csv
 ```
 
+

{degiro_cli-0.1.3 → degiro_cli-0.1.4}/degiro_cli.egg-info/SOURCES.txt

@@ -11,4 +11,5 @@ degirocli/__init__.py
 degirocli/helpers.py
 degirocli/history.py
 degirocli/login.py
+degirocli/portfolio.py
 degirocli/search.py

{degiro_cli-0.1.3 → degiro_cli-0.1.4}/degiro_cli.egg-info/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
 degiro-history = degirocli.history:main
 degiro-login = degirocli.login:main
+degiro-portfolio = degirocli.portfolio:main
 degiro-search = degirocli.search:main

{degiro_cli-0.1.3 → degiro_cli-0.1.4}/degiro_cli.egg-info/requires.txt

@@ -1,4 +1,4 @@
-degiroasync>=1.0.0
+degiroasync>=1.1.0
 
 [dev]
 pytest>=7.0.1

{degiro_cli-0.1.3 → degiro_cli-0.1.4}/degirocli/login.py

@@ -1,12 +1,9 @@
 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
@@ -17,10 +14,10 @@ import degiroasync.api as dapi
 import degiroasync.webapi as wapi
 import degiroasync.core as dcore
 
-from .helpers import ERROR_CODES
-from .helpers import LOGGER
+from .helpers import ERROR_CODES, LOGGER
 
 
+_USER_MASK = stat.S_IRUSR | stat.S_IWUSR
 
 def get_credentials() -> dapi.Credentials:
     """
@@ -55,10 +52,17 @@ def get_credentials() -> dapi.Credentials:
 
 
 def get_tmp_path():
+    "Return temporary path specific to current user."
     tmpdir = Path(tempfile.gettempdir())
-    return tmpdir / 'degirocli' 
 
-def _get_hash(path: Union[Path, str]) -> str:
+    # parent folder must be readable and writable by other users on multi-user systems.
+    module_folder = tmpdir / 'degirocli'
+    module_folder.mkdir(mode=0o777, exist_ok=True)
+
+    user_path = module_folder / str(os.getuid())
+    return user_path
+
+def _get_hash(path: Union[Path, str]) -> int:
     with open(path, 'rb') as fh:
         fhash = hash(fh)
     return fhash
@@ -116,17 +120,7 @@ def expire_path(
     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():
+async def login(*, expire_session_file: int = 3*60*60):
     tmp_path = get_tmp_path()
 
     if tmp_path.exists():
@@ -140,8 +134,21 @@ async def login():
     # 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)
+    LOGGER.debug("temporary file: %s", tmp_path)
+    tmp_path.touch(exist_ok=True)
+    # Check current user owns the file.
+    tmp_stat = os.stat(tmp_path)
+    if tmp_stat.st_uid != os.getuid():
+        msg = (
+            f"Session cache file user identifier (UID) {tmp_stat.st_uid} is" 
+            f" different from current user UID {os.getuid()}."
+            "This should not happen and could be a local attack. "
+            "Abort."
+               )
+        LOGGER.error(msg)
+        return
+        raise AssertionError()
+    tmp_path.chmod(_USER_MASK)
     with open(tmp_path, 'w') as fh:
         json.dump({
             'version': 1,
@@ -151,7 +158,7 @@ async def login():
                 ),
             }, fh)
     # Delete file in 3 hour
-    expire_path(tmp_path, 3*60*60)
+    expire_path(tmp_path, expire_session_file)
 
 async def _get_session_from_cache() -> dapi.Session:
     cache_path = get_tmp_path()

degiro_cli-0.1.4/degirocli/portfolio.py

@@ -0,0 +1,173 @@
+import sys
+import asyncio
+import logging
+import io
+import argparse
+import csv
+from typing import Optional, Sequence, Literal
+
+import degiroasync.api as dapi
+
+from .helpers import LOGGER
+from .login import get_session_from_cache
+
+
+async def run_portfolio_pipeline(
+        session: dapi.Session,
+        output_file: io.TextIOBase,
+        *,
+        headers: bool = True,
+        position_type: Optional[str] = None,
+        filter: Literal['all', 'open', 'closed'] = 'open',
+        ):
+    """
+    Fetch and output portfolio data.
+    """
+    positions: Sequence[dapi.Position] = await dapi.get_portfolio(session, filter=filter)
+    
+    exc_dict: dapi.ExchangeDictionary = session.dictionary
+    writer = csv.writer(output_file)
+    if headers:
+        writer.writerow((
+            "position_type",
+            "exchange",
+            "isin",
+            "name",
+            "currency",
+            "size",
+            "price",
+            "value",
+        ))
+    
+    for position in positions:
+        if position_type is not None and position.position_type != position_type:
+            continue
+        
+        exchange = "N/A"
+        
+        info = position.product.info
+        if hasattr(info, 'exchange_id'):
+            # Should be the case for stock products at least.
+            try:
+                exchange_obj = exc_dict.exchange_by(id=info.exchange_id)
+                exchange = exchange_obj.hiq_abbr if exchange_obj else ""
+            except KeyError:
+                LOGGER.warning("Exchange id %s unknown.", info.exchange_id)
+                exchange = "Unknown"
+        
+        LOGGER.debug("position: %s", position)
+        LOGGER.debug("info: %s", info)
+        writer.writerow((
+            position.position_type,
+            exchange,
+            info.isin,
+            info.name,
+            info.currency,
+            position.size,
+            position.price,
+            position.value,
+        ))
+
+
+async def run_portfolio_total_pipeline(
+        session: dapi.Session,
+        output_file: io.TextIOBase
+        ):
+    """
+    Fetch and output total portfolio data.
+    """
+    total_portfolio = await dapi.get_portfolio_total(session)
+    
+    writer = csv.writer(output_file)
+    
+    # TotalPortfolio is an object with attributes, iterate over public ones
+    for attr_name in dir(total_portfolio):
+        if not attr_name.startswith('_'):
+            writer.writerow((attr_name, getattr(total_portfolio, attr_name)))
+
+
+def main():
+    handler = logging.StreamHandler()
+
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="Get user portfolio from DEGIRO."
+            )
+    parser.add_argument(
+        '-f',
+        '--filter',
+        dest='filter',
+        default='open',
+        required=False,
+        help="Get either 'all', 'open' (default) or 'closed' positions only."
+    )
+    parser.add_argument(
+            '--total',
+            dest='total',
+            default=False,
+            action='store_true',
+            required=False,
+            help="Get total portfolio summary instead of individual positions"
+            )
+    parser.add_argument(
+            '-t',
+            '--type',
+            dest='position_type',
+            default=None,
+            required=False,
+            help="Filter by position type: PRODUCT or CASH"
+            )
+    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
+    position_type = args.position_type
+    if position_type is not None:
+        position_type = position_type.upper()
+    get_total = args.total
+    filter = args.filter
+    if get_total and filter != 'open':
+        print("--filter does not work with --total. Abort.")
+        return
+
+    logging_level = logging.WARNING
+    if args.debug:
+        logging_level = logging.DEBUG
+    handler.setLevel(logging_level)
+    LOGGER.setLevel(logging_level)
+    LOGGER.addHandler(handler)
+
+    output_io: io.TextIOBase = sys.stdout  # type: ignore
+
+    session = get_session_from_cache()
+    session.update_throttling(max_requests=7, period_seconds=1)
+
+    if get_total:
+        if print_headers:
+            writer = csv.writer(sys.stdout)
+            writer.writerow(("key", "value"))
+        asyncio.run(run_portfolio_total_pipeline(session, output_io))
+    else:
+        asyncio.run(
+                run_portfolio_pipeline(
+                    session,
+                    output_file=output_io,
+                    position_type=position_type,
+                    headers=print_headers,
+                    )
+                )

{degiro_cli-0.1.3 → degiro_cli-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "degiro-cli"
-version = "0.1.3"
+version = "0.1.4"
 authors = [{ name = "ohmajesticlama", email = "ohmajesticlama@gmail.com" }]
 description = "Unofficial command line tools for Degiro"
 readme = "README.md"
@@ -23,7 +23,7 @@ classifiers = [
 keywords = ["degiro", "cli", "finance", "investment"]
 
 dependencies = [
-    "degiroasync >= 1.0.0",
+    "degiroasync >= 1.1.0",
 ]
 
 [project.urls]
@@ -34,6 +34,7 @@ dependencies = [
 degiro-login = "degirocli.login:main"
 degiro-history = "degirocli.history:main"
 degiro-search = "degirocli.search:main"
+degiro-portfolio = "degirocli.portfolio:main"
 
 [project.optional-dependencies]
 dev = [