outnote 1.1.0__tar.gz → 1.2.0__tar.gz

{outnote-1.1.0 → outnote-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: outnote
-Version: 1.1.0
+Version: 1.2.0
 Summary: Headless Microsoft 365 client - mail, calendar, Teams, OneDrive, SharePoint and OneNote over Graph, no app registration.
 Keywords: microsoft,microsoft-365,microsoft-graph,graph-api,outlook,onenote,onedrive,sharepoint,teams,mail,calendar,headless,no-app-registration,foci,entra
 Author: PianoNic
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Office/Business
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: ms-entrance>=1.3
+Requires-Dist: ms-entrance>=1.4
 Requires-Dist: pypdf>=4 ; extra == 'pdf'
 Requires-Python: >=3.10
 Project-URL: Homepage, https://github.com/PianoNic/OutNote

{outnote-1.1.0 → outnote-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "outnote"
-version = "1.1.0"
+version = "1.2.0"
 description = "Headless Microsoft 365 client - mail, calendar, Teams, OneDrive, SharePoint and OneNote over Graph, no app registration."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -43,7 +43,7 @@ classifiers = [
     "Topic :: Office/Business",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-dependencies = ["ms-entrance>=1.3"]
+dependencies = ["ms-entrance>=1.4"]
 
 [[project.authors]]
 name = "PianoNic"

{outnote-1.1.0 → outnote-1.2.0}/pyproject.toml.orig

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "outnote"
-version = "1.1.0"
+version = "1.2.0"
 description = "Headless Microsoft 365 client - mail, calendar, Teams, OneDrive, SharePoint and OneNote over Graph, no app registration."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -47,7 +47,7 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 dependencies = [
-    "ms-entrance>=1.3",
+    "ms-entrance>=1.4",
 ]
 
 [project.optional-dependencies]

outnote-1.2.0/src/outnote/_auth.py

@@ -0,0 +1,58 @@
+"""Headless Microsoft 365 sign-in - a thin wrapper over `entrance.foci_login`.
+
+All the auth mechanics (PKCE sign-in, device code, the FOCI family refresh
+token, the token broker and its persistence) live in `entrance`; OutNote only
+supplies the Microsoft 365 specifics - the sign-in client and the Office client
+used to validate a stored token.
+"""
+
+from entrance import OFFICEHOME, foci_login
+
+from ._base import C_OFFICE
+from ._graph import OutNote
+
+__all__ = ["authenticate", "OFFICEHOME"]
+
+
+def authenticate(
+    username=None,
+    password=None,
+    *,
+    tenant="common",
+    totp_secret=None,
+    totp_code=None,
+    cookies=".ms_session.json",
+    frt_store=".ms_frt",
+    device=False,
+    open_browser=False,
+    on_prompt=None,
+    **login_kwargs,
+):
+    """Sign in and return an `OutNote` client wired to a token broker.
+
+    No app registration or admin consent needed. If `frt_store` holds a live
+    refresh token, no sign-in happens at all. Otherwise pick how to sign in:
+      * default - headless (password + TOTP, or a seeded cookie jar).
+      * `device=True` - the device code flow: a short code shown on the terminal
+        that you enter at a URL, no browser redirect or copy-paste (the Office
+        client is used, which supports it and brokers to every M365 service).
+      * `interactive=True` / `"always"` - finish in a browser.
+    MFA: pass `totp_secret` (Base32) or `totp_code`. Extra kwargs pass through
+    to `entrance.login`.
+    """
+    broker = foci_login(
+        username,
+        password,
+        client_id=C_OFFICE if device else OFFICEHOME,
+        tenant=tenant,
+        totp_secret=totp_secret,
+        totp_code=totp_code,
+        cookies=cookies,
+        frt_store=frt_store,
+        probe_client=C_OFFICE,
+        device=device,
+        open_browser=open_browser,
+        on_prompt=on_prompt,
+        **login_kwargs,
+    )
+    return OutNote(broker)

{outnote-1.1.0 → outnote-1.2.0}/src/outnote/_cli.py

@@ -10,17 +10,31 @@ import json
 import os
 import sys
 
+from entrance import DeviceCodeError, LoginFailed, TokenError
+
 from ._auth import authenticate
+from ._base import GraphError
 from ._text import message_text
 
+_SIGNIN_HELP = """Not signed in. Do one of:
+  - sign in (easiest):   outnote signin
+      shows a short code to enter at https://login.microsoft.com/device
+  - or set credentials (first run only):
+      OUTNOTE_USER / OUTNOTE_PASSWORD / OUTNOTE_TOTP   (set on Windows, export on POSIX)
+Either way a refresh token is saved (OUTNOTE_FRT, default .ms_frt), so later runs
+need neither. `outnote signin --browser` signs in in a browser instead."""
+
 
-def _client():
+def _client(device=False, browser=False):
     return authenticate(
         os.environ.get("OUTNOTE_USER"),
         os.environ.get("OUTNOTE_PASSWORD"),
         totp_secret=os.environ.get("OUTNOTE_TOTP"),
         cookies=os.environ.get("OUTNOTE_COOKIES", ".ms_session.json"),
         frt_store=os.environ.get("OUTNOTE_FRT", ".ms_frt"),
+        device=device,
+        open_browser=device,  # also open the device page automatically
+        interactive="always" if browser else False,
     )
 
 
@@ -75,6 +89,12 @@ def main(argv=None):
     ap = argparse.ArgumentParser(prog="outnote", description="Microsoft 365 over Graph.")
     ap.add_argument("--text", action="store_true", help="readable output instead of JSON")
     sub = ap.add_subparsers(dest="cmd", required=True)
+    p = sub.add_parser(
+        "signin",
+        aliases=["login"],
+        help="sign in (device code by default, or --browser) and save the session",
+    )
+    p.add_argument("--browser", action="store_true", help="sign in in a browser instead")
     sub.add_parser("me")
     p = sub.add_parser("mail")
     p.add_argument("--folder", default="inbox")
@@ -100,8 +120,44 @@ def main(argv=None):
     p = sub.add_parser("get", help="raw GET of any Graph path")
     p.add_argument("path")
     a = ap.parse_args(argv)
+    sys.stdout.reconfigure(encoding="utf-8")  # type: ignore[union-attr]
+    signin = a.cmd in ("signin", "login")
+    browser = getattr(a, "browser", False)
+
+    try:
+        # `signin` defaults to the device code flow; --browser switches to a browser.
+        note = _client(device=signin and not browser, browser=browser)
+    except LoginFailed:
+        print(_SIGNIN_HELP, file=sys.stderr)
+        return 2
+    except TokenError as e:
+        print(f"Sign-in failed: {e}", file=sys.stderr)
+        if e.error in ("invalid_grant", "interaction_required"):
+            print("\n" + _SIGNIN_HELP, file=sys.stderr)
+        return 2
+    except DeviceCodeError as e:
+        print(f"Sign-in failed: {e}", file=sys.stderr)
+        return 2
 
-    note = _client()
+    if signin:
+        me = note.me()
+        store = os.environ.get("OUTNOTE_FRT", ".ms_frt")
+        print(f"Signed in as {me.get('displayName')} <{me.get('userPrincipalName')}>.")
+        print(f"Session saved to {store} - later commands reuse it, no sign-in needed.")
+        return 0
+
+    try:
+        data = _run(a, note)
+    except GraphError as e:
+        print(f"Graph error: {e}", file=sys.stderr)
+        return 1
+
+    out = _text(a.cmd, data, note) if a.text else json.dumps(data, indent=2, ensure_ascii=False)
+    print(out)
+    return 0
+
+
+def _run(a, note):
     if a.cmd == "me":
         data = note.me()
     elif a.cmd == "mail":
@@ -120,11 +176,7 @@ def main(argv=None):
         data = note.files(a.path)
     else:
         data = note.get(a.path)
-
-    out = _text(a.cmd, data, note) if a.text else json.dumps(data, indent=2, ensure_ascii=False)
-    sys.stdout.reconfigure(encoding="utf-8")  # type: ignore[union-attr]
-    print(out)
-    return 0
+    return data
 
 
 if __name__ == "__main__":

outnote-1.1.0/src/outnote/_auth.py

@@ -1,48 +0,0 @@
-"""Headless Microsoft 365 sign-in - a thin wrapper over `entrance.foci_login`.
-
-All the auth mechanics (PKCE sign-in, the FOCI family refresh token, the token
-broker and its persistence) live in `entrance`; OutNote only supplies the
-Microsoft 365 specifics - the OfficeHome sign-in client (entrance's default)
-and the Office client used to validate a stored token.
-"""
-
-from entrance import OFFICEHOME, foci_login
-
-from ._base import C_OFFICE
-from ._graph import OutNote
-
-__all__ = ["authenticate", "OFFICEHOME"]
-
-
-def authenticate(
-    username=None,
-    password=None,
-    *,
-    tenant="common",
-    totp_secret=None,
-    totp_code=None,
-    cookies=".ms_session.json",
-    frt_store=".ms_frt",
-    **login_kwargs,
-):
-    """Sign in and return an `OutNote` client wired to a token broker.
-
-    No app registration or admin consent needed. If `frt_store` holds a live
-    refresh token, no sign-in happens at all; otherwise `entrance` signs in and
-    the new token is saved there (pass `frt_store=None` to disable).
-    `username`/`password` are optional once `cookies` holds a live session.
-    MFA: pass `totp_secret` (Base32) or `totp_code`; or `interactive=True` to
-    finish in a browser. Extra kwargs pass through to `entrance.login`.
-    """
-    broker = foci_login(
-        username,
-        password,
-        tenant=tenant,
-        totp_secret=totp_secret,
-        totp_code=totp_code,
-        cookies=cookies,
-        frt_store=frt_store,
-        probe_client=C_OFFICE,
-        **login_kwargs,
-    )
-    return OutNote(broker)