Avoid modifying sys.path (#123)

* remove modification of sys.path Signed-off-by: Shashank Mittal <[email protected]> * remove unnecessary imports Signed-off-by: Shashank Mittal <[email protected]> * ruff check Signed-off-by: Shashank Mittal <[email protected]> * #122 update docs with directions to pip install the local version --------- Signed-off-by: Shashank Mittal <[email protected]> Co-authored-by: Andrew Tavis McAllister <[email protected]>
scribe-org · Mar 29, 2024 · a7ed7f0 · a7ed7f0
1 parent 2b72e64
commit a7ed7f0
Show file tree

Hide file tree

Showing 35 changed files with 34 additions and 175 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -139,6 +139,7 @@ After activating the virtual environment, install the required dependencies by r
 ```bash
 pip install --upgrade pip  # make sure that pip is at the latest version
 pip install -r requirements.txt  # install dependencies
+pip install -e .  # install the local version of Scribe-Data
 ```
 
 > [!NOTE]

diff --git a/README.md b/README.md
@@ -159,6 +159,7 @@ After activating the virtual environment, install the required dependencies by r
 ```bash
 pip install --upgrade pip  # make sure that pip is at the latest version
 pip install -r requirements.txt  # install dependencies
+pip install -e .  # install the local version of Scribe-Data
 ```
 
 > [!NOTE]

diff --git a/docs/source/_static/CONTRIBUTING.rst b/docs/source/_static/CONTRIBUTING.rst
@@ -129,6 +129,7 @@ GitHub also has documentation on how to `Generate a new SSH key <https://docs.gi
     python3 -m venv venv  # make an environment venv
     pip install --upgrade pip  # make sure that pip is at the latest version
     pip install -r requirements.txt  # install dependencies
+    pip install -e .  # install the local version of Scribe-Data
 
 ..
 

diff --git a/src/scribe_data/extract_transform/languages/English/nouns/format_nouns.py b/src/scribe_data/extract_transform/languages/English/nouns/format_nouns.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/English/translations/translate_words.py b/src/scribe_data/extract_transform/languages/English/translations/translate_words.py
@@ -8,13 +8,8 @@
 
 import json
 import os
-import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.extract_transform.translation.translation_utils import (  # noqa: E402
+from scribe_data.extract_transform.translation.translation_utils import (
     translate_to_other_languages,
 )
 

diff --git a/src/scribe_data/extract_transform/languages/English/verbs/format_verbs.py b/src/scribe_data/extract_transform/languages/English/verbs/format_verbs.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/French/nouns/format_nouns.py b/src/scribe_data/extract_transform/languages/French/nouns/format_nouns.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import (  # noqa: E402
+from scribe_data.utils import (
     export_formatted_data,
     load_queried_data,
     map_genders,

diff --git a/src/scribe_data/extract_transform/languages/French/translations/translate_words.py b/src/scribe_data/extract_transform/languages/French/translations/translate_words.py
@@ -8,13 +8,8 @@
 
 import json
 import os
-import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.extract_transform.translation.translation_utils import (  # noqa: E402
+from scribe_data.extract_transform.translation.translation_utils import (
     translate_to_other_languages,
 )
 

diff --git a/src/scribe_data/extract_transform/languages/French/verbs/format_verbs.py b/src/scribe_data/extract_transform/languages/French/verbs/format_verbs.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/German/nouns/format_nouns.py b/src/scribe_data/extract_transform/languages/German/nouns/format_nouns.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import (  # noqa: E402
+from scribe_data.utils import (
     export_formatted_data,
     load_queried_data,
     map_genders,

diff --git a/src/scribe_data/extract_transform/languages/German/prepositions/format_prepositions.py b/src/scribe_data/extract_transform/languages/German/prepositions/format_prepositions.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/German/translations/translate_words.py b/src/scribe_data/extract_transform/languages/German/translations/translate_words.py
@@ -8,13 +8,8 @@
 
 import json
 import os
-import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.extract_transform.translation.translation_utils import (  # noqa: E402
+from scribe_data.extract_transform.translation.translation_utils import (
     translate_to_other_languages,
 )
 

diff --git a/src/scribe_data/extract_transform/languages/German/verbs/format_verbs.py b/src/scribe_data/extract_transform/languages/German/verbs/format_verbs.py
@@ -11,11 +11,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/Italian/nouns/format_nouns.py b/src/scribe_data/extract_transform/languages/Italian/nouns/format_nouns.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import (  # noqa: E402
+from scribe_data.utils import (
     export_formatted_data,
     load_queried_data,
     map_genders,

diff --git a/src/scribe_data/extract_transform/languages/Italian/translations/translate_words.py b/src/scribe_data/extract_transform/languages/Italian/translations/translate_words.py
@@ -8,13 +8,8 @@
 
 import json
 import os
-import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.extract_transform.translation.translation_utils import (  # noqa: E402
+from scribe_data.extract_transform.translation.translation_utils import (
     translate_to_other_languages,
 )
 

diff --git a/src/scribe_data/extract_transform/languages/Italian/verbs/format_verbs.py b/src/scribe_data/extract_transform/languages/Italian/verbs/format_verbs.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/Portuguese/nouns/format_nouns.py b/src/scribe_data/extract_transform/languages/Portuguese/nouns/format_nouns.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import (  # noqa: E402
+from scribe_data.utils import (
     export_formatted_data,
     load_queried_data,
     map_genders,

diff --git a/src/scribe_data/extract_transform/languages/Portuguese/translations/translate_words.py b/src/scribe_data/extract_transform/languages/Portuguese/translations/translate_words.py
@@ -8,13 +8,8 @@
 
 import json
 import os
-import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.extract_transform.translation.translation_utils import (  # noqa: E402
+from scribe_data.extract_transform.translation.translation_utils import (
     translate_to_other_languages,
 )
 

diff --git a/src/scribe_data/extract_transform/languages/Portuguese/verbs/format_verbs.py b/src/scribe_data/extract_transform/languages/Portuguese/verbs/format_verbs.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/Russian/nouns/format_nouns.py b/src/scribe_data/extract_transform/languages/Russian/nouns/format_nouns.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import (  # noqa: E402
+from scribe_data.utils import (
     export_formatted_data,
     load_queried_data,
     map_genders,

diff --git a/src/scribe_data/extract_transform/languages/Russian/prepositions/format_prepositions.py b/src/scribe_data/extract_transform/languages/Russian/prepositions/format_prepositions.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/Russian/translations/translate_words.py b/src/scribe_data/extract_transform/languages/Russian/translations/translate_words.py
@@ -8,13 +8,8 @@
 
 import json
 import os
-import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.extract_transform.translation.translation_utils import (  # noqa: E402
+from scribe_data.extract_transform.translation.translation_utils import (
     translate_to_other_languages,
 )
 

diff --git a/src/scribe_data/extract_transform/languages/Russian/verbs/format_verbs.py b/src/scribe_data/extract_transform/languages/Russian/verbs/format_verbs.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/Spanish/nouns/format_nouns.py b/src/scribe_data/extract_transform/languages/Spanish/nouns/format_nouns.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import (  # noqa: E402
+from scribe_data.utils import (
     export_formatted_data,
     load_queried_data,
     map_genders,

diff --git a/src/scribe_data/extract_transform/languages/Spanish/translations/translate_words.py b/src/scribe_data/extract_transform/languages/Spanish/translations/translate_words.py
@@ -8,13 +8,8 @@
 
 import json
 import os
-import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.extract_transform.translation.translation_utils import (  # noqa: E402
+from scribe_data.extract_transform.translation.translation_utils import (
     translate_to_other_languages,
 )
 

diff --git a/src/scribe_data/extract_transform/languages/Spanish/verbs/format_verbs.py b/src/scribe_data/extract_transform/languages/Spanish/verbs/format_verbs.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/languages/Swedish/nouns/format_nouns.py b/src/scribe_data/extract_transform/languages/Swedish/nouns/format_nouns.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import (  # noqa: E402
+from scribe_data.utils import (
     export_formatted_data,
     load_queried_data,
     map_genders,

diff --git a/src/scribe_data/extract_transform/languages/Swedish/translations/translate_words.py b/src/scribe_data/extract_transform/languages/Swedish/translations/translate_words.py
@@ -8,13 +8,8 @@
 
 import json
 import os
-import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.extract_transform.translation.translation_utils import (  # noqa: E402
+from scribe_data.extract_transform.translation.translation_utils import (
     translate_to_other_languages,
 )
 

diff --git a/src/scribe_data/extract_transform/languages/Swedish/verbs/format_verbs.py b/src/scribe_data/extract_transform/languages/Swedish/verbs/format_verbs.py
@@ -6,11 +6,7 @@
 import os
 import sys
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import export_formatted_data, load_queried_data  # noqa: E402
+from scribe_data.utils import export_formatted_data, load_queried_data
 
 file_path = sys.argv[0]
 

diff --git a/src/scribe_data/extract_transform/translation/translation_utils.py b/src/scribe_data/extract_transform/translation/translation_utils.py
@@ -7,17 +7,11 @@
 """
 
 import json
-import os
 import signal
-import sys
 
 from transformers import M2M100ForConditionalGeneration, M2M100Tokenizer
 
-PATH_TO_SCRIBE_ORG = os.path.dirname(sys.path[0]).split("Scribe-Data")[0]
-PATH_TO_SCRIBE_DATA_SRC = f"{PATH_TO_SCRIBE_ORG}Scribe-Data/src"
-sys.path.insert(0, PATH_TO_SCRIBE_DATA_SRC)
-
-from scribe_data.utils import (  # noqa: E402
+from scribe_data.utils import (
     get_language_dir_path,
     get_language_iso,
     get_target_langcodes,