python-setenv 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

python_setenv-0.0.2.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: python-setenv
+Version: 0.0.2
+Summary: Set env (e.g. HF_TOKEN) from colab/kaggle secrets or dotenv .env env files
+Author-email: ffreemt <yucongo+fmt@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: python-dotenv>=1.0.0
+Description-Content-Type: text/markdown
+
+<!---[![pytest](https://github.com/ffreemt/python-setenv/actions/workflows/routine-tests.yml/badge.svg)](https://github.com/ffreemt/python-setenv/actions)-->
+# python-setenv
+[![pytest](https://github.com/ffreemt/python-setenv/actions/workflows/routine-tests.yml/badge.svg)](https://github.com/ffreemt/python-setenv/actions)[![python](https://img.shields.io/static/v1?label=python+&message=3.8%2B&color=blue)](https://www.python.org/downloads/)[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)[![PyPI version](https://badge.fury.io/py/python-setenv.svg)](https://badge.fury.io/py/python-setenv)
+
+Set an environ variable from colab, kaggle or dotenv (search default .env/dotenv/env)
+
+### Why `python-setenv`
+
+colab and kaggle both provide a way to manage secrets (typically API tokens).
+
+`python-setenv` is mainly for running ipynb (jupyter notebook) files in colab/kaggle or cloud instance when we need to set an environ variable, for example, `HF_TOKEN` to download models or datasets from huggingdace hub, other scenarios include `WANDB_API_KEY` or `NGROK_AUTHCODE` or `OPENAI_API_KEY` etc.
+
+When running an ipynb in a cloud instance, we may use `dotenv` (`pip install python-dotenv`) to set environ varibales based on `.env`.
+
+### Install it
+```
+pip install python-setenv
+```
+
+### Setup Secrets or Upload `.env`
+
+* In colab, set Secrets
+
+    <img src="https://github.com/ffreemt/python-setenv/raw/main/img/colab.png" width="300" />
+
+    <!---![](img/colab.png)-->
+
+* In kaggle, set Add-ons/Secrets
+
+    <img src="https://github.com/ffreemt/python-setenv/raw/main/img/kaggle.png" width="300" />
+
+    <!---![](./img/kaggle.png)-->
+
+* In other jupyter environ/cloud instance, upload .env, with contents, e.g.
+```
+HF_TOKEN=...
+WANDB_API_KEY=...
+```
+In some cases, files start with a dot are not allowed. Rename `.env` to `dotenv` or `env` instead, `setenv` will auto-search for `.env`, `dotenv` and `env`.
+
+## Use it
+```
+from setenv import setenv
+
+# e.g.
+setenv("HF_TOKEN")
+setenv("WANDB_API_KEY")
+setenv("NGROK_AUTHCODE")
+```
+
+Sometimes we want to set HF_TOKEN to HF_TOKEN_W (with write-permission).
+```
+from setenv import setenv
+setenv(env_var="HF_TOKEN", source_var="HF_TOKEN_W")
+```
+This is effectively equivalent to `os.environ["HF_TOKEN"] = get_secret("HF_TOKEN_W")` when in colab or kaggle, or `os.environ["HF_TOKEN"] = dotenv.dotenv_values().get("HF_TOKEN_W")`.

python_setenv-0.0.2.dist-info/RECORD

@@ -0,0 +1,4 @@
+python_setenv-0.0.2.dist-info/METADATA,sha256=K5Tw5D4A-3vDL08QweD3BxHFAYhZUzCOVL9bszefpIg,2847
+python_setenv-0.0.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+python_setenv-0.0.2.dist-info/licenses/LICENSE,sha256=_uswrdKCdw7w6eijHhtUmEBb6YEg7uk5lYnf_FJpS3o,1085
+python_setenv-0.0.2.dist-info/RECORD,,

python_setenv-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ffreemt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_setenv-0.0.1.dist-info/METADATA

@@ -1,7 +0,0 @@
-Metadata-Version: 2.4
-Name: python-setenv
-Version: 0.0.1
-Summary: Set env (e.g. HF_TOKEN) from colab/kaggle secrets or dotenv .env env files
-Author-email: ffreemt <yucongo+fmt@gmail.com>
-Requires-Python: >=3.10
-Requires-Dist: python-dotenv>=1.2.1

python_setenv-0.0.1.dist-info/RECORD

@@ -1,5 +0,0 @@
-setenv/__init__.py,sha256=ZRkV6G4CkdVIZwsVXXtn7jrP8YSIHKPDLOifoI7z8rc,3558
-setenv/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-python_setenv-0.0.1.dist-info/METADATA,sha256=ZT4-kPoD3xl7iNF_aV6exyWxGX-QpK0YmcW8zUDFD9s,247
-python_setenv-0.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-python_setenv-0.0.1.dist-info/RECORD,,

setenv/__init__.py

@@ -1,131 +0,0 @@
-"""Set an environ var in colab/kaggle/dotenv(search for .env dotenv env).
-
-!pip install -q python-dotenv
-"""
-# pylint: disable=import-outside-toplevel,too-many-statements,too-many-branches
-
-import os
-# import sys
-
-from pathlib import Path
-from dotenv import dotenv_values, find_dotenv
-# from loguru import logger
-
-__version__ = "0.0.1"
-
-
-def hello() -> str:
-    return "Hello from python-setenv!"
-
-
-# def set_env(
-def setenv(
-    env_var="HF_TOKEN", source_var=None, envfile=None, override=False,
-    # verbose=False
-):
-    """
-    Set environ var via google userdat/kaggle_secrets/[.env/dotenv/env].
-
-    Args:
-    ----
-    env_var:
-        env var to set, default HF_TOKEN.
-    source_var:
-        var from google/kaggle secret/userdata
-        or defined in .env/dotenv/env
-    envfile: file to read from, default, search
-        for ['.env', 'dotenv', 'env']
-    override:
-        reset if set to True
-    x verbose:
-        for loguru.logging, print TRACE if set
-
-    Returns:
-    -------
-    value of the env var.
-    """
-    _ = '''
-    if verbose:
-        logger.remove()
-        logger.add(sys.stderr, level="TRACE")  # default "DEBUG"
-    # '''
-    if not override and os.getenv(env_var):
-        return os.getenv(env_var)
-
-    # if override:
-    save_env_var = os.getenv(env_var)
-    if os.getenv(env_var) is not None:
-        del os.environ[env_var]
-
-    if source_var is None:
-        source_var = env_var
-
-    # if KAGGLE
-    if "KAGGLE_KERNEL" in " ".join(os.environ.keys()):
-        # import kaggle_web_client  # type: ignore
-        from kaggle_secrets import UserSecretsClient  # type: ignore
-
-        user_secrets = UserSecretsClient()
-        try:
-            os.environ[env_var] = user_secrets.get_secret(source_var)
-            return os.getenv(env_var)
-        except Exception:
-            return ""
-
-    # try colab COLAB_NOTEBOOK
-    if "COLAB_NOTEBOOK" in " ".join(os.environ.keys()):
-        from google.colab import userdata  # noqa  # type: ignore
-        try:
-            os.environ[env_var] = userdata.get(source_var)
-            return os.getenv(env_var)
-        except Exception:
-            return ""
-
-    # .env dotenv env
-    # envfile = None
-
-    # cwd
-    print(f"cwd: {Path.cwd()}, {envfile=}")
-
-    if envfile is None:
-        for _ in [".env", "dotenv", "env"]:
-            # filepath = Path.cwd() / _
-            # envfile = find_dotenv(filepath.as_posix())
-            filepath = _
-            envfile = find_dotenv(filepath)
-            if envfile:
-                # logger.trace(f"Found {envfile=}")
-                print(f"Found {envfile=}")
-                break
-
-    if envfile:
-        print(f"loading {envfile=} with dotenv_values(envfile)")
-        if dotenv_values(envfile).get(source_var):
-            _ = dotenv_values(envfile).get(source_var)
-            if _:  # need to be a str
-                os.environ[env_var] = _
-            print(f"{envfile=}: set {env_var}={source_var}")
-    if os.getenv(env_var):
-        return os.getenv(env_var)
-
-    # try manual input?
-    print(
-        f"""
-        Unable to set {env_var}={source_var},
-        not in colab or Secrets not set, not kaggle
-        or Secrets not set, no .env/dotenv/env file
-        in the current working dir or parent dirs or env not present."""
-    )
-
-    # restore?
-    if override:
-        # save_env_var may be None
-        if save_env_var:
-            if os.getenv(env_var) is not None:
-                os.environ[env_var] = save_env_var
-
-        print(f"Restore {env_var=}")
-
-    return ""
-
-__all__ = ("__version__", "setenv",)