sygmail 0.1.0__tar.gz → 0.1.1__tar.gz

{sygmail-0.1.0/sygmail.egg-info → sygmail-0.1.1}/PKG-INFO

@@ -1,12 +1,14 @@
 Metadata-Version: 2.4
 Name: sygmail
-Version: 0.1.0
+Version: 0.1.1
 Summary: Lightweight Gmail notification wrapper
-Author-email: Satoshi Nakabayashi <3104nkb@gmail.com>
+Author: Satoshi Nakabayashi
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: yagmail
+Provides-Extra: keyring
+Requires-Dist: keyring; extra == "keyring"
 Dynamic: license-file
 
 # sygmail
@@ -30,6 +32,7 @@ pip install sygmail
 
 - Python 3.9+
 - Dependency: `yagmail`
+- Optional: `keyring` (for OS credential store support)
 
 ## Quick start
 
@@ -53,9 +56,31 @@ SYGMAIL_APP_PASSWORD=app-password
 SYGMAIL_TO=to@example.com
 SYGMAIL_SUBJECT=Process Completed
 SYGMAIL_CONTENTS={script_name} has finished running.
-SYGMAIL_ATTACHMENTS_PATH=./a/
+SYGMAIL_ATTACHMENTS_PATH=/path/to/folder
 ```
 
+If you use keyring, you can leave `SYGMAIL_APP_PASSWORD` empty.
+
+Install keyring support:
+
+```
+pip install "sygmail[keyring]"
+```
+
+Keyring usage:
+
+```bash
+python -m sygmail config set --from you@gmail.com --app-password "app-password" --use-keyring
+python -m sygmail send
+```
+
+Notes:
+
+- Passwords are stored under the service name `sygmail` with the `from` address as the username.
+- If `SYGMAIL_APP_PASSWORD` is set, it is used first; otherwise keyring is used.
+- Storage uses your OS credential manager (macOS Keychain, Windows Credential Manager, or a Linux keyring).
+- To remove a stored password, delete it from your OS credential manager.
+
 ## Defaults
 
 - Subject: `Process Completed`
@@ -98,8 +123,8 @@ python -m sygmail send \
     --to to@example.com \
     --subject "Process Completed" \
     --contents "[sygmail notification]" \
-    --attachments ./path/to/file \
-    --attachments-path ./path/to/folder/
+    --attachments /path/to/file \
+    --attachments-path /path/to/folder/
 ```
 
 - If `--contents` is omitted, CLI uses `[sygmail notification]` without editing `.env`.
@@ -111,10 +136,14 @@ python -m sygmail send
 
 python -m sygmail send --subject "Job Done" --contents "[sygmail notification]"
 
-python -m sygmail send --attachments ./a/a.txt ./a/b.txt
+python -m sygmail send --attachments /path/to/file-a.txt /path/to/file-b.txt
+
+python -m sygmail send --attachments-path /path/to/folder/
 
 python -m sygmail config set --from you@gmail.com --app-password "app-password"
 
+python -m sygmail config set --from you@gmail.com --app-password "app-password" --use-keyring
+
 python -m sygmail config show
 ```
 
@@ -128,7 +157,7 @@ python -m sygmail config set \
     --to to@example.com \
     --subject "Process Completed" \
     --contents "{script_name} has finished running." \
-    --attachments-path ./a/
+    --attachments-path /path/to/folder/
 
 python -m sygmail config reset --env .env
 

{sygmail-0.1.0 → sygmail-0.1.1}/README.md

@@ -19,6 +19,7 @@ pip install sygmail
 
 - Python 3.9+
 - Dependency: `yagmail`
+- Optional: `keyring` (for OS credential store support)
 
 ## Quick start
 
@@ -42,9 +43,31 @@ SYGMAIL_APP_PASSWORD=app-password
 SYGMAIL_TO=to@example.com
 SYGMAIL_SUBJECT=Process Completed
 SYGMAIL_CONTENTS={script_name} has finished running.
-SYGMAIL_ATTACHMENTS_PATH=./a/
+SYGMAIL_ATTACHMENTS_PATH=/path/to/folder
 ```
 
+If you use keyring, you can leave `SYGMAIL_APP_PASSWORD` empty.
+
+Install keyring support:
+
+```
+pip install "sygmail[keyring]"
+```
+
+Keyring usage:
+
+```bash
+python -m sygmail config set --from you@gmail.com --app-password "app-password" --use-keyring
+python -m sygmail send
+```
+
+Notes:
+
+- Passwords are stored under the service name `sygmail` with the `from` address as the username.
+- If `SYGMAIL_APP_PASSWORD` is set, it is used first; otherwise keyring is used.
+- Storage uses your OS credential manager (macOS Keychain, Windows Credential Manager, or a Linux keyring).
+- To remove a stored password, delete it from your OS credential manager.
+
 ## Defaults
 
 - Subject: `Process Completed`
@@ -87,8 +110,8 @@ python -m sygmail send \
     --to to@example.com \
     --subject "Process Completed" \
     --contents "[sygmail notification]" \
-    --attachments ./path/to/file \
-    --attachments-path ./path/to/folder/
+    --attachments /path/to/file \
+    --attachments-path /path/to/folder/
 ```
 
 - If `--contents` is omitted, CLI uses `[sygmail notification]` without editing `.env`.
@@ -100,10 +123,14 @@ python -m sygmail send
 
 python -m sygmail send --subject "Job Done" --contents "[sygmail notification]"
 
-python -m sygmail send --attachments ./a/a.txt ./a/b.txt
+python -m sygmail send --attachments /path/to/file-a.txt /path/to/file-b.txt
+
+python -m sygmail send --attachments-path /path/to/folder/
 
 python -m sygmail config set --from you@gmail.com --app-password "app-password"
 
+python -m sygmail config set --from you@gmail.com --app-password "app-password" --use-keyring
+
 python -m sygmail config show
 ```
 
@@ -117,7 +144,7 @@ python -m sygmail config set \
     --to to@example.com \
     --subject "Process Completed" \
     --contents "{script_name} has finished running." \
-    --attachments-path ./a/
+    --attachments-path /path/to/folder/
 
 python -m sygmail config reset --env .env
 
@@ -167,4 +194,4 @@ Sygmail.send(
 ## Operations
 
 - Prefer `chmod 600 .env` on shared machines.
-- Use `--env` to separate configs per project.
+- Use `--env` to separate configs per project.

{sygmail-0.1.0 → sygmail-0.1.1}/pyproject.toml

@@ -4,12 +4,15 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sygmail"
-version = "0.1.0"
+version = "0.1.1"
 description = "Lightweight Gmail notification wrapper"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = ["yagmail"]
-authors = [{name = "Satoshi Nakabayashi", email = "3104nkb@gmail.com"}]
+authors = [{name = "Satoshi Nakabayashi"}]
+
+[project.optional-dependencies]
+keyring = ["keyring"]
 
 [project.scripts]
 sygmail = "sygmail.cli:main"

{sygmail-0.1.0 → sygmail-0.1.1}/sygmail/cli.py

@@ -36,6 +36,11 @@ def build_parser() -> argparse.ArgumentParser:
     config_set_parser.add_argument("--env", default=".env", help="Path to .env file")
     config_set_parser.add_argument("--from", dest="from_addr", help="From address")
     config_set_parser.add_argument("--app-password", help="Gmail app password")
+    config_set_parser.add_argument(
+        "--use-keyring",
+        action="store_true",
+        help="Store app password in keyring instead of .env",
+    )
     config_set_parser.add_argument("--to", help="To address")
     config_set_parser.add_argument("--subject", help="Email subject")
     config_set_parser.add_argument("--contents", help="Email contents")
@@ -110,6 +115,7 @@ def run_config_set(args: argparse.Namespace) -> int:
         subject=args.subject,
         contents=args.contents,
         attachments_path=args.attachments_path,
+        use_keyring=args.use_keyring,
         persist=True,
     )
     return 0

{sygmail-0.1.0 → sygmail-0.1.1}/sygmail/client.py

@@ -7,8 +7,14 @@ from typing import Iterable, List, Optional
 
 import yagmail
 
+try:
+    import keyring
+except ImportError:  # pragma: no cover - optional dependency
+    keyring = None
+
 DEFAULT_SUBJECT = "Process Completed"
 DEFAULT_CONTENTS_TEMPLATE = "{script_name} has finished running."
+KEYRING_SERVICE = "sygmail"
 
 ENV_KEYS = {
     "from_addr": "SYGMAIL_FROM",
@@ -80,13 +86,20 @@ class Sygmail:
         subject: Optional[str] = None,
         contents: Optional[str] = None,
         attachments_path: Optional[str] = None,
+        use_keyring: bool = False,
         persist: bool = True,
     ) -> None:
         if from_addr is None and from_ is not None:
             from_addr = from_
         if from_addr is not None:
             self.config.from_addr = from_addr
-        if app_password is not None:
+        if app_password is not None and use_keyring:
+            resolved_from = from_addr or self.config.from_addr
+            if not resolved_from:
+                raise ValueError("from_addr is required to store keyring password")
+            _store_keyring_password(resolved_from, app_password)
+            self.config.app_password = None
+        elif app_password is not None:
             self.config.app_password = app_password
         if to is not None:
             self.config.to = to
@@ -117,7 +130,7 @@ class Sygmail:
         **kwargs,
     ) -> None:
         resolved_from = from_addr or from_ or self.config.from_addr
-        app_password = self.config.app_password
+        app_password = self.config.app_password or _get_keyring_password(resolved_from)
         target = to or self.config.to or resolved_from
 
         if not resolved_from or not app_password or not target:
@@ -205,6 +218,21 @@ def _warn_missing_attachments(paths: Iterable[str]) -> None:
     warnings.warn(f"missing attachments ignored: {joined}", stacklevel=3)
 
 
+def _get_keyring_password(username: Optional[str]) -> Optional[str]:
+    if not username or keyring is None:
+        return None
+    try:
+        return keyring.get_password(KEYRING_SERVICE, username)
+    except Exception:
+        return None
+
+
+def _store_keyring_password(username: str, password: str) -> None:
+    if keyring is None:
+        raise RuntimeError("keyring is not installed")
+    keyring.set_password(KEYRING_SERVICE, username, password)
+
+
 def _read_env_file(env_path: str) -> dict:
     path = Path(env_path)
     if not path.exists():

{sygmail-0.1.0 → sygmail-0.1.1/sygmail.egg-info}/PKG-INFO

@@ -1,12 +1,14 @@
 Metadata-Version: 2.4
 Name: sygmail
-Version: 0.1.0
+Version: 0.1.1
 Summary: Lightweight Gmail notification wrapper
-Author-email: Satoshi Nakabayashi <3104nkb@gmail.com>
+Author: Satoshi Nakabayashi
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: yagmail
+Provides-Extra: keyring
+Requires-Dist: keyring; extra == "keyring"
 Dynamic: license-file
 
 # sygmail
@@ -30,6 +32,7 @@ pip install sygmail
 
 - Python 3.9+
 - Dependency: `yagmail`
+- Optional: `keyring` (for OS credential store support)
 
 ## Quick start
 
@@ -53,9 +56,31 @@ SYGMAIL_APP_PASSWORD=app-password
 SYGMAIL_TO=to@example.com
 SYGMAIL_SUBJECT=Process Completed
 SYGMAIL_CONTENTS={script_name} has finished running.
-SYGMAIL_ATTACHMENTS_PATH=./a/
+SYGMAIL_ATTACHMENTS_PATH=/path/to/folder
 ```
 
+If you use keyring, you can leave `SYGMAIL_APP_PASSWORD` empty.
+
+Install keyring support:
+
+```
+pip install "sygmail[keyring]"
+```
+
+Keyring usage:
+
+```bash
+python -m sygmail config set --from you@gmail.com --app-password "app-password" --use-keyring
+python -m sygmail send
+```
+
+Notes:
+
+- Passwords are stored under the service name `sygmail` with the `from` address as the username.
+- If `SYGMAIL_APP_PASSWORD` is set, it is used first; otherwise keyring is used.
+- Storage uses your OS credential manager (macOS Keychain, Windows Credential Manager, or a Linux keyring).
+- To remove a stored password, delete it from your OS credential manager.
+
 ## Defaults
 
 - Subject: `Process Completed`
@@ -98,8 +123,8 @@ python -m sygmail send \
     --to to@example.com \
     --subject "Process Completed" \
     --contents "[sygmail notification]" \
-    --attachments ./path/to/file \
-    --attachments-path ./path/to/folder/
+    --attachments /path/to/file \
+    --attachments-path /path/to/folder/
 ```
 
 - If `--contents` is omitted, CLI uses `[sygmail notification]` without editing `.env`.
@@ -111,10 +136,14 @@ python -m sygmail send
 
 python -m sygmail send --subject "Job Done" --contents "[sygmail notification]"
 
-python -m sygmail send --attachments ./a/a.txt ./a/b.txt
+python -m sygmail send --attachments /path/to/file-a.txt /path/to/file-b.txt
+
+python -m sygmail send --attachments-path /path/to/folder/
 
 python -m sygmail config set --from you@gmail.com --app-password "app-password"
 
+python -m sygmail config set --from you@gmail.com --app-password "app-password" --use-keyring
+
 python -m sygmail config show
 ```
 
@@ -128,7 +157,7 @@ python -m sygmail config set \
     --to to@example.com \
     --subject "Process Completed" \
     --contents "{script_name} has finished running." \
-    --attachments-path ./a/
+    --attachments-path /path/to/folder/
 
 python -m sygmail config reset --env .env
 

sygmail-0.1.1/sygmail.egg-info/requires.txt

@@ -0,0 +1,4 @@
+yagmail
+
+[keyring]
+keyring

sygmail-0.1.0/sygmail.egg-info/requires.txt

@@ -1 +0,0 @@
-yagmail