Merge branch 'master' into master

ramwin · web-flow · commit 3068cd87ed1c · 2022-06-20T09:16:32.000+08:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -23,3 +23,9 @@ jobs:
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
         make release
+
+    - name: Publish Documentation
+      run: |
+        pip install -r requirements-docs.txt
+        pip install -e .
+        mkdocs gh-deploy --force
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,3 +16,14 @@ or with [tox](https://pypi.org/project/tox/) installed:
 
     $ tox
 
+
+Documentation is published with [mkdocs]():
+
+```shell
+$ pip install -r requirements-docs.txt
+$ pip install -e .
+$ mkdocs serve
+```
+
+Open http://127.0.0.1:8000/ to view the documentation locally.
+
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,11 +1,13 @@
 include LICENSE *.md *.yml *.toml
 
 include tox.ini
+recursive-include docs *.md
 recursive-include tests *.py
 
 include .bumpversion.cfg
 include .coveragerc
 include .editorconfig
 include Makefile
 include requirements.txt
+include requirements-docs.txt
 include src/dotenv/py.typed
diff --git a/README.md b/README.md
@@ -225,6 +225,7 @@ defined in the following list:
 -   [dump-env](https://github.com/sobolevn/dump-env)
 -   [environs](https://github.com/sloria/environs)
 -   [dynaconf](https://github.com/rochacbruno/dynaconf)
+-   [parse_it](https://github.com/naorlivne/parse_it)
 
 ## Acknowledgements
 
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1 @@
+../CHANGELOG.md
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1 @@
+../CONTRIBUTING.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+../README.md
diff --git a/docs/reference.md b/docs/reference.md
@@ -0,0 +1,3 @@
+# Reference
+
+::: dotenv
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,23 @@
+site_name: python-dotenv
+repo_url: https://github.com/theskumar/python-dotenv
+edit_uri: ""
+theme:
+  name: material
+  palette:
+    primary: green
+markdown_extensions:
+  - mdx_truly_sane_lists
+plugins:
+  - mkdocstrings:
+      handlers:
+        python:
+          rendering:
+            show_root_heading: yes
+            show_submodules: no
+            separate_signature: yes
+  - search
+nav:
+  - Home: index.md
+  - Changelog: changelog.md
+  - Contributing: contributing.md
+  - Reference: reference.md
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -0,0 +1,5 @@
+mdx_truly_sane_lists~=1.2
+mkdocs-include-markdown-plugin~=3.3.0
+mkdocs-material~=8.2.9
+mkdocstrings[python]~=0.18.1
+mkdocs~=1.3.0
diff --git a/requirements.txt b/requirements.txt
@@ -1,13 +1,11 @@
+black~=22.3.0
 bumpversion
 click
 flake8>=2.2.3
 ipython
-mock
 pytest-cov
 pytest>=3.9
 sh>=1.09
 tox
-types-mock
-wheel
 twine
-portray
+wheel
diff --git a/setup.py b/setup.py
@@ -37,7 +37,7 @@ def read_files(files):
     },
     entry_points={
         "console_scripts": [
-            "dotenv=dotenv.cli:cli",
+            "dotenv=dotenv.__main__:cli",
         ],
     },
     license='BSD-3-Clause',
diff --git a/src/dotenv/__main__.py b/src/dotenv/__main__.py
@@ -0,0 +1,6 @@
+"""Entry point for cli, enables execution with `python -m dotenv`"""
+
+from .cli import cli
+
+if __name__ == "__main__":
+    cli()
diff --git a/src/dotenv/cli.py b/src/dotenv/cli.py
@@ -158,7 +158,3 @@ def run_command(command: List[str], env: Dict[str, str]) -> int:
     _, _ = p.communicate()
 
     return p.returncode
-
-
-if __name__ == "__main__":
-    cli()
diff --git a/src/dotenv/main.py b/src/dotenv/main.py
@@ -87,6 +87,9 @@ def set_as_environment_variables(self) -> bool:
         """
         Load the current dotenv as system environment variable.
         """
+        if not self.dict():
+            return False
+
         for k, v in self.dict().items():
             if k in os.environ and not self.override:
                 continue
@@ -198,10 +201,10 @@ def unset_key(
     encoding: Optional[str] = "utf-8",
 ) -> Tuple[Optional[bool], str]:
     """
-    Removes a given key from the given .env
+    Removes a given key from the given `.env` file.
 
-    If the .env path given doesn't exist, fails
-    If the given key doesn't exist in the .env, fails
+    If the .env path given doesn't exist, fails.
+    If the given key doesn't exist in the .env, fails.
     """
     if not os.path.exists(dotenv_path):
         logger.warning("Can't delete from %s - it doesn't exist.", dotenv_path)
@@ -316,16 +319,19 @@ def load_dotenv(
 ) -> bool:
     """Parse a .env file and then load all the variables found as environment variables.
 
-    - *dotenv_path*: absolute or relative path to .env file.
-    - *stream*: Text stream (such as `io.StringIO`) with .env content, used if
-      `dotenv_path` is `None`.
-    - *verbose*: whether to output a warning the .env file is missing. Defaults to
-      `False`.
-    - *override*: whether to override the system environment variables with the variables
-      in `.env` file.  Defaults to `False`.
-    - *encoding*: encoding to be used to read the file.
+    Parameters:
+        dotenv_path: Absolute or relative path to .env file.
+        stream: Text stream (such as `io.StringIO`) with .env content, used if
+            `dotenv_path` is `None`.
+        verbose: Whether to output a warning the .env file is missing.
+        override: Whether to override the system environment variables with the variables
+            from the `.env` file.
+        encoding: Encoding to be used to read the file.
+    Returns:
+        Bool: True if atleast one environment variable is set elese False
 
-    If both `dotenv_path` and `stream`, `find_dotenv()` is used to find the .env file.
+    If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the
+    .env file.
     """
     if dotenv_path is None and stream is None:
         dotenv_path = find_dotenv()
@@ -357,13 +363,11 @@ def dotenv_values(
     `{"foo": None}`
 
     Parameters:
-
-    - `dotenv_path`: absolute or relative path to the .env file.
-    - `stream`: `StringIO` object with .env content, used if `dotenv_path` is `None`.
-    - `verbose`: whether to output a warning if the .env file is missing. Defaults to
-      `False`.
-    - `encoding`: encoding to be used to read the file. Defaults to `"utf-8"`.
-    - `with_env`: include the os.environ() to response.
+        dotenv_path: Absolute or relative path to the .env file.
+        stream: `StringIO` object with .env content, used if `dotenv_path` is `None`.
+        verbose: Whether to output a warning if the .env file is missing.
+        encoding: Encoding to be used to read the file.
+        with_env: include the os.environ() to response.
 
     If both `dotenv_path` and `stream` are `None`, `find_dotenv()` is used to find the
     .env file.
diff --git a/tests/test_ipython.py b/tests/test_ipython.py
@@ -1,6 +1,10 @@
 import os
+from unittest import mock
 
-import mock
+import pytest
+
+
+pytest.importorskip("IPython")
 
 
 @mock.patch.dict(os.environ, {}, clear=True)
diff --git a/tests/test_main.py b/tests/test_main.py
@@ -3,8 +3,8 @@
 import os
 import sys
 import textwrap
+from unittest import mock
 
-import mock
 import pytest
 import sh
 
@@ -259,8 +259,9 @@ def test_load_dotenv_no_file_verbose():
     logger = logging.getLogger("dotenv.main")
 
     with mock.patch.object(logger, "info") as mock_info:
-        dotenv.load_dotenv('.does_not_exist', verbose=True)
+        result = dotenv.load_dotenv('.does_not_exist', verbose=True)
 
+    assert result is False
     mock_info.assert_called_once_with("Python-dotenv could not find configuration file %s.", ".does_not_exist")
 
 
diff --git a/tox.ini b/tox.ini
@@ -14,7 +14,6 @@ python =
 
 [testenv]
 deps =
-  mock
   pytest
   coverage
   sh
@@ -27,7 +26,6 @@ skip_install = true
 deps =
   flake8
   mypy
-  types-mock
 commands =
   flake8 src tests
   mypy --python-version=3.11 src tests
