Change order of arguments

Author: ashleve

README.md

@@ -2,7 +2,7 @@
 
 [![Python](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/release/python-370/)
 [![Tests](https://github.com/ashleve/pyrootutils/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/ashleve/pyrootutils/actions/workflows/test.yml)
-[![codecov](https://codecov.io/gh/ashleve/pyrootutils/branch/main/graph/badge.svg)](https://codecov.io/gh/ashleve/pyrootutils)
+[![Codecov](https://codecov.io/gh/ashleve/pyrootutils/branch/main/graph/badge.svg)](https://codecov.io/gh/ashleve/pyrootutils)
 [![Issues](https://img.shields.io/github/issues/ashleve/pyrootutils)](https://github.com/ashleve/pyrootutils/issues)
 [![License](https://img.shields.io/github/license/ashleve/pyrootutils)](https://github.com/ashleve/pyrootutils/blob/main/LICENSE)
 [![Release](https://img.shields.io/pypi/v/pyrootutils)](pypi.org/project/pyrootutils/1.0.0/)
@@ -51,10 +51,10 @@ assert data_dir.exists(), f"path doesn't exist: {data_dir}"
 # set root directory
 pyrootutils.set_root(
     path=path # path to the root directory
-    pythonpath=True, # add root directory to the PYTHONPATH (helps with imports)
-    cwd=True, # set current working directory to the root directory (helps with filepaths)
     project_root_env_var=True, # set the PROJECT_ROOT environment variable to root directory
     dotenv=True, # load environment variables from .env if exists in root directory
+    pythonpath=True, # add root directory to the PYTHONPATH (helps with imports)
+    cwd=True, # change current working directory to the root directory (helps with filepaths)
 )
 ```
 
@@ -65,11 +65,11 @@ import pyrootutils
 # combines find_root() and set_root() into one method
 root = pyrootutils.setup_root(
     search_from=__file__,
-    indicator=".git" # indicator of the root directory
-    pythonpath=True,
-    cwd=True,
+    indicator=".pyproject.toml"
     project_root_env_var=True,
     dotenv=True,
+    pythonpath=True,
+    cwd=True,
 )
 ```
 

pyrootutils/__init__.py

@@ -2,4 +2,4 @@
 
 __all__ = ["find_root", "set_root", "setup_root"]
 
-__version__ = "1.0.2"
+__version__ = "1.0.3"

pyrootutils/pyrootutils.py

@@ -77,19 +77,19 @@ def find_root(
 
 def set_root(
     path: Union[str, Path],
-    pythonpath: bool = True,
-    cwd: bool = True,
     project_root_env_var: bool = True,
     dotenv: bool = True,
+    pythonpath: bool = True,
+    cwd: bool = True,
 ) -> None:
     """Set given path as a project root.
 
     Args:
         path (Union[str, Path]): project root path.
-        pythonpath (bool, optional): whether to add project root to pythonpath.
-        cwd (bool, optional): whether to set current working directory to project root.
         project_root_env_var (bool, optional): whether to set PROJECT_ROOT environment variable to project root.
         dotenv (bool, optional): whether to load .env file from project root.
+        pythonpath (bool, optional): whether to add project root to pythonpath.
+        cwd (bool, optional): whether to set current working directory to project root.
 
     Raises:
         FileNotFoundError: if root path does not exist.
@@ -102,18 +102,18 @@ def set_root(
     if not os.path.exists(path):
         raise FileNotFoundError(f"Project root path does not exist: {path}")
 
-    if pythonpath:
-        sys.path.insert(0, path)
-
-    if cwd:
-        os.chdir(path)
-
     if project_root_env_var:
         os.environ["PROJECT_ROOT"] = path
 
     if dotenv:
         load_dotenv(os.path.join(path, ".env"))
 
+    if pythonpath:
+        sys.path.insert(0, path)
+
+    if cwd:
+        os.chdir(path)
+
 
 def setup_root(
     search_from: Union[str, Path],
@@ -124,24 +124,30 @@ def setup_root(
         ".git",
         "pyproject.toml",
     ),
-    pythonpath: bool = True,
-    cwd: bool = True,
     project_root_env_var: bool = True,
     dotenv: bool = True,
+    pythonpath: bool = True,
+    cwd: bool = True,
 ) -> Path:
     """Combines `get_root()` and `set_root()` into one method.
 
     Args:
         search_from (str): path to folder to start search from.
         indicator (Union[str, Iterable[str]], optional): Project root indicator(s). Defaults to ".project-root".
-        pythonpath (bool, optional): whether to add project root to pythonpath.
-        cwd (bool, optional): whether to set current working directory to project root.
         project_root_env_var (bool, optional): whether to set PROJECT_ROOT environment variable to project root.
         dotenv (bool, optional): whether to load .env file from project root.
+        pythonpath (bool, optional): whether to add project root to pythonpath.
+        cwd (bool, optional): whether to set current working directory to project root.
 
     Returns:
         Path: path to project root.
     """
     path = find_root(search_from, indicator)
-    set_root(path, pythonpath, cwd, project_root_env_var, dotenv)
+    set_root(
+        path=path,
+        project_root_env_var=project_root_env_var,
+        dotenv=dotenv,
+        pythonpath=pythonpath,
+        cwd=cwd,
+    )
     return path

tests/test_pyrootutils.py

@@ -64,12 +64,12 @@ def test_set_root():
 
     assert "PROJECT_ROOT" not in os.environ
 
-    set_root(path, pythonpath=False, cwd=False, project_root_env_var=True, dotenv=False)
+    set_root(path, project_root_env_var=True, dotenv=False, pythonpath=False, cwd=False)
     assert "PROJECT_ROOT" in os.environ
     assert os.environ["PROJECT_ROOT"] == str(path)
     assert os.getcwd() != str(path)
 
-    set_root(path, pythonpath=True, cwd=True, project_root_env_var=True, dotenv=True)
+    set_root(path, project_root_env_var=True, dotenv=True, pythonpath=True, cwd=True)
     assert os.getcwd() == str(path)
     assert str(path) in sys.path