atomicshop 2.9.33__py3-none-any.whl → 2.10.0__py3-none-any.whl

atomicshop/__init__.py

@@ -1,4 +1,4 @@
 """Atomic Basic functions and classes to make developer life easier"""
 
 __author__ = "Den Kras"
-__version__ = '2.9.33'
+__version__ = '2.10.0'

atomicshop/wrappers/elasticsearchw/config_basic.py

@@ -6,10 +6,15 @@ DEFAULT_KIBANA_PORT: str = '5601'
 DEFAULT_KIBANA_HOST: str = 'localhost'
 DEFAULT_KIBANA_URL: str = f"http://{DEFAULT_KIBANA_HOST}:{DEFAULT_KIBANA_PORT}"
 
-ELASTIC_CONFIG_FILE: str = "/etc/elasticsearch/elasticsearch.yml"
-ELASTIC_JVM_OPTIONS_FILE: str = "/etc/elasticsearch/jvm.options"
+ELASTIC_SEARCH_CONFIG_DIRECTORY: str = "/etc/elasticsearch"
+
+ELASTIC_CONFIG_FILE: str = f"{ELASTIC_SEARCH_CONFIG_DIRECTORY}/elasticsearch.yml"
 XPACK_SECURITY_SETTING_NAME: str = "xpack.security.enabled"
 
+ELASTIC_JVM_OPTIONS_DIRECTORY: str = f"{ELASTIC_SEARCH_CONFIG_DIRECTORY}/jvm.options.d"
+ELASTIC_JVM_OPTIONS_CUSTOM_FILE: str = f"{ELASTIC_JVM_OPTIONS_DIRECTORY}/custom.options"
+ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE: list[str] = ['-Xms4g', '-Xmx4g']
+
 UBUNTU_DEPENDENCY_PACKAGES: list[str] = ['apt-transport-https', 'openjdk-11-jdk', 'wget']
 UBUNTU_ELASTIC_PACKAGE_NAME: str = 'elasticsearch'
 UBUNTU_ELASTIC_SERVICE_NAME: str = 'elasticsearch'

atomicshop/wrappers/elasticsearchw/infrastructure.py

@@ -170,6 +170,29 @@ def modify_xpack_security_setting(
             print_api(f"The setting is already set to [{setting}].")
 
 
+def create_jvm_options_custom_file(file_path: str = None, options: list = None):
+    """
+    The function creates a custom JVM options file for Elasticsearch.
+    The default file path is 'config_basic.ELASTIC_JVM_OPTIONS_CUSTOM_FILE'.
+    The default options are 'config_basic.ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE'.
+    The 4GB memory usage options are needed for the Elasticsearch to work properly and not to crash.
+    :param file_path: str, the path to the custom JVM options file.
+    :param options: list, the list of JVM options.
+    :return:
+    """
+
+    if not file_path:
+        file_path = config_basic.ELASTIC_JVM_OPTIONS_CUSTOM_FILE
+
+    if not options:
+        options = config_basic.ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE
+
+    # Write the options to the file.
+    with open(file_path, 'w') as file:
+        for option in options:
+            file.write(f"{option}\n")
+
+
 def is_server_available(
         max_attempts: int = 5,
         wait_between_attempts_seconds: float = 10,

atomicshop/wrappers/elasticsearchw/install_elastic.py

@@ -215,6 +215,12 @@ def install_elastic_kibana_ubuntu(install_elastic: bool = True, install_kibana:
 
         infrastructure.start_elastic_and_check_service_availability()
 
+        print_api("Creating custom JVM options file with 4GB memory usage.")
+        infrastructure.create_jvm_options_custom_file(
+            file_path=config_basic.ELASTIC_JVM_OPTIONS_CUSTOM_FILE,
+            options=config_basic.ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE
+        )
+
     if install_kibana:
         # Install Kibana.
         ubuntu_terminal.install_packages([config_basic.UBUNTU_KIBANA_PACKAGE_NAME])

atomicshop/wrappers/githubw.py

@@ -1,18 +1,79 @@
 import requests
 import fnmatch
 
-from ..web import download_and_extract_file
+from .. import web, urls
 from ..print_api import print_api
-from ..urls import url_parser
 
 
 class GitHubWrapper:
     # You also can use '.tar.gz' as extension.
     def __init__(
-            self, user_name: str = str(), repo_name: str = str(), repo_url: str = str(),
-            branch: str = 'master', branch_file_extension: str = '.zip'):
+            self,
+            user_name: str = None,
+            repo_name: str = None,
+            repo_url: str = None,
+            branch: str = 'master',
+            branch_file_extension: str = '.zip'
+    ):
+        """
+        This class is a wrapper for GitHub repositories. It can download the branch file from the repository and extract
+        it to the target directory and more.
+
+        :param user_name: str, the user-name of the repository.
+             https://github.com/{user_name}/{repo_name}
+        :param repo_name: str, the repository name.
+        :param repo_url: str, the repository url.
+            You can provide the full url to the repository directly and then extract the user_name and repo_name from it
+            with the 'build_links_from_repo_url' function.
+        :param branch: str, the branch name. The default is 'master'.
+        :param branch_file_extension: str, the branch file extension. The default is '.zip'.
+
+        ================================================================================================================
+        Usage to download the 'master' branch file:
+            git_wrapper = GitHubWrapper(user_name='user_name', repo_name='repo_name')
+            git_wrapper.download_and_extract_branch(target_directory='target_directory')
+
+        Usage to download the 'main' branch file:
+            git_wrapper = GitHubWrapper(user_name='user_name', repo_name='repo_name', branch='main')
+            git_wrapper.download_and_extract_branch(target_directory='target_directory')
+
+        You can provide the user_name and repo_name after the initialization of the class:
+            git_wrapper = GitHubWrapper()
+            git_wrapper.user_name = 'user_name'
+            git_wrapper.repo_name = 'repo_name'
+            git_wrapper.build_links_from_user_and_repo()
+            git_wrapper.download_and_extract_branch(target_directory='target_directory')
+        ================================================================================================================
+        Usage to download the 'master' branch file from the repository url:
+            git_wrapper = GitHubWrapper(repo_url='http://github.com/user_name/repo_name')
+            git_wrapper.download_and_extract_branch(target_directory='target_directory')
+
+        Usage to download the 'main' branch file from the repository url:
+            git_wrapper = GitHubWrapper(repo_url='http://github.com/user_name/repo_name', branch='main')
+            git_wrapper.download_and_extract_branch(target_directory='target_directory')
+
+        You can provide the repo_url after the initialization of the class:
+            git_wrapper = GitHubWrapper()
+            git_wrapper.repo_url = 'http://github.com/user_name/repo_name'
+            git_wrapper.build_links_from_repo_url()
+            git_wrapper.download_and_extract_branch(target_directory='target_directory')
+        ================================================================================================================
+        Usage to download the latest release where the file name is 'test_file.zip':
+            git_wrapper = GitHubWrapper(user_name='user_name', repo_name='repo_name')
+            git_wrapper.download_and_extract_latest_release(
+                target_directory='target_directory', string_pattern='test_*.zip')
+        ================================================================================================================
+        Usage to get the latest release json:
+            git_wrapper = GitHubWrapper(user_name='user_name', repo_name='repo_name')
+            git_wrapper.get_the_latest_release_json()
+        ================================================================================================================
+        Usage to get the latest release version:
+            git_wrapper = GitHubWrapper(user_name='user_name', repo_name='repo_name')
+            git_wrapper.get_the_latest_release_version_number()
+        """
+
         self.user_name: str = user_name
-        self.repo_name = repo_name
+        self.repo_name: str = repo_name
         self.repo_url: str = repo_url
         self.branch: str = branch
         self.branch_file_extension: str = branch_file_extension
@@ -27,6 +88,12 @@ class GitHubWrapper:
         self.branch_downloaded_folder_name: str = str()
         self.latest_release_json_url: str = str()
 
+        if self.user_name and self.repo_name and not self.repo_url:
+            self.build_links_from_user_and_repo()
+
+        if self.repo_url and not self.user_name and not self.repo_name:
+            self.build_links_from_repo_url()
+
     def build_links_from_user_and_repo(self, **kwargs):
         if not self.user_name or not self.repo_name:
             message = "'user_name' or 'repo_name' is empty."
@@ -43,7 +110,7 @@ class GitHubWrapper:
             message = "'repo_url' is empty."
             print_api(message, color="red", error_type=True, **kwargs)
 
-        repo_url_parsed = url_parser(self.repo_url)
+        repo_url_parsed = urls.url_parser(self.repo_url)
         self.check_github_domain(repo_url_parsed['netloc'])
         self.user_name = repo_url_parsed['directories'][0]
         self.repo_name = repo_url_parsed['directories'][1]
@@ -73,20 +140,32 @@ class GitHubWrapper:
         """
 
         # Download the repo to current working directory, extract and remove the archive.
-        download_and_extract_file(
+        web.download_and_extract_file(
             file_url=self.branch_download_link,
             target_directory=target_directory,
             archive_remove_first_directory=archive_remove_first_directory,
             **kwargs)
 
     def download_and_extract_latest_release(
-            self, target_directory: str, string_pattern: str,
-            archive_remove_first_directory: bool = False, **kwargs):
-        # Download latest release url.
-        response = requests.get(self.latest_release_json_url)
-        # Response from the latest releases page is json. Convert response to json from downloaded format and get
-        # 'assets' key.
-        github_latest_releases_list = response.json()['assets']
+            self,
+            target_directory: str,
+            string_pattern: str,
+            archive_remove_first_directory: bool = False,
+            **kwargs):
+        """
+        This function will download the latest release from the GitHub repository, extract the file and remove the file,
+        leaving only the extracted folder.
+        :param target_directory: str, the target directory to download and extract the file.
+        :param string_pattern: str, the string pattern to search in the latest release. Wildcards can be used.
+        :param archive_remove_first_directory: bool, sets if archive extract function will extract the archive
+            without first directory in the archive. Check reference in the
+            'archiver.zip.extract_archive_with_zipfile' function.
+        :param kwargs: dict, the print arguments for the 'print_api' function.
+        :return:
+        """
+
+        # Get the 'assets' key of the latest release json.
+        github_latest_releases_list = self.get_the_latest_release_json()['assets']
 
         # Get only download urls of the latest releases.
         download_urls: list = list()
@@ -103,8 +182,23 @@ class GitHubWrapper:
                       f'{found_urls}'
             print_api(message, color="red", error_type=True, **kwargs)
 
-        download_and_extract_file(
+        web.download_and_extract_file(
             file_url=found_urls[0],
             target_directory=target_directory,
             archive_remove_first_directory=archive_remove_first_directory,
             **kwargs)
+
+    def get_the_latest_release_json(self):
+        """
+        This function will get the latest releases json.
+        :return:
+        """
+        response = requests.get(self.latest_release_json_url)
+        return response.json()
+
+    def get_the_latest_release_version_number(self):
+        """
+        This function will get the latest release version number.
+        :return:
+        """
+        return self.get_the_latest_release_json()['tag_name']

atomicshop/wrappers/nodejsw/install_nodejs.py

@@ -1,7 +1,8 @@
 import subprocess
-import getpass
+import requests
 
-from ... import process, filesystem, permissions
+from ...basics import booleans
+from .. import githubw, ubuntu_terminal
 from ...print_api import print_api
 
 
@@ -28,22 +29,103 @@ def is_nodejs_installed():
         return False
 
 
-def install_nodejs_ubuntu():
+def get_nodejs_latest_version_number(
+        by_github_api: bool = True,
+        _by_nodejs_website: bool = False,
+        get_major: bool = False
+) -> str:
+    """
+    The function will get the latest version number of Node.js.
+    :param by_github_api: bool, if True, the function will get the version number using the GitHub API.
+        Limitations: rate limits apply.
+    :param _by_nodejs_website: bool, if True, the function will get the version number using the Node.js website.
+        Limitations: the website structure can change and the json file is relatively large.
+        This is only for reference, it is not tested.
+    :param get_major: bool, if True, the function will return only the major version number string.
+    :return: str.
+    """
+
+    if by_github_api and _by_nodejs_website:
+        raise ValueError("Only one of the arguments can be True.")
+    elif not by_github_api and not _by_nodejs_website:
+        raise ValueError("At least one of the arguments must be True.")
+
+    latest_version = ''
+    if by_github_api:
+        github_wrapper = githubw.GitHubWrapper('nodejs', 'node')
+        latest_version = github_wrapper.get_the_latest_release_version_number()
+    elif _by_nodejs_website:
+        url = "https://nodejs.org/dist/index.json"
+        response = requests.get(url)
+        versions = response.json()
+        latest_version = versions[0]['version']  # Assuming the first one is the latest.
+
+    if get_major:
+        latest_version = latest_version.replace('v', '')
+        latest_version = latest_version.split('.')[0]
+
+    return latest_version
+
+
+def install_nodejs_ubuntu(
+        install_latest_version: bool = False,
+        install_lts: bool = True,
+        install_by_version_number: str = None,
+        force_install: bool = False
+):
     """
     The function will install Node.js on Ubuntu.
+
+    :param install_latest_version: bool, if True, the function will install the latest version of Node.js.
+    :param install_lts: bool, if True, the function will install the LTS version of Node.js.
+    :param install_by_version_number: str, the version number of Node.js to install.
+    :param force_install: bool, if True, the function will install Node.js even if it is already installed.
+
     :return:
     """
 
+    booleans.check_3_booleans_when_only_1_can_be_true(
+        (install_latest_version, 'install_latest_version'),
+        (install_lts, 'install_lts'),
+        (install_by_version_number, 'install_by_version_number')
+    )
+
     # Check if Node.js is already installed.
     if is_nodejs_installed():
-        return
+        if not force_install:
+            return
 
-    # Add the Node.js repository.
-    process.run_command(['curl', '-sL', 'https://deb.nodesource.com/setup_14.x', '-o', '/tmp/nodesource_setup.sh'])
-    process.run_command(['bash', '/tmp/nodesource_setup.sh'])
+    print_api("Adding NodeSource repository...")
 
-    # Install Node.js
-    process.run_command(['apt-get', 'install', '-y', 'nodejs'])
+    # Fetch and execute the NodeSource repository setup script.
+    if install_latest_version:
+        install_by_version_number: str = get_nodejs_latest_version_number(get_major=True)
+
+    command: str = ''
+    if install_latest_version or install_by_version_number:
+        command = f"curl -fsSL https://deb.nodesource.com/setup_{install_by_version_number}.x | sudo -E bash -"
+    elif install_lts:
+        command = "curl -fsSL https://deb.nodesource.com/setup_current.x | sudo -E bash -"
+
+    _ = subprocess.check_output(command, shell=True, stderr=subprocess.STDOUT)
+
+    ubuntu_terminal.update_system_packages()
+    ubuntu_terminal.install_packages(['nodejs'])
+
+    # Check if Node.js is installed.
+    is_nodejs_installed()
+
+
+def install_npm_package_ubuntu(package_name: str):
+    """
+    The function will install a npm package on Ubuntu.
+    :param package_name: str, the name of the package to install.
+    :return:
+    """
 
     # Check if Node.js is installed.
-    is_nodejs_installed()
+    if not is_nodejs_installed():
+        return
+
+    command = f"npm install -g {package_name}"
+    _ = subprocess.check_output(command, shell=True, stderr=subprocess.STDOUT)

{atomicshop-2.9.33.dist-info → atomicshop-2.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.9.33
+Version: 2.10.0
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License

{atomicshop-2.9.33.dist-info → atomicshop-2.10.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=xZ_X7wkuj9RC8hITqUIPCnbV_tPMEP3Ct3FVSt2GWdM,123
+atomicshop/__init__.py,sha256=Vb-OirUUuTpKZXUvWHYjzscN4SeetO7oxaKph1XstLw,123
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_create_pdf_demo.py,sha256=Yi-PGZuMg0RKvQmLqVeLIZYadqEZwUm-4A9JxBl_vYA,3713
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
@@ -143,7 +143,7 @@ atomicshop/wrappers/astw.py,sha256=VkYfkfyc_PJLIOxByT6L7B8uUmKY6-I8XGZl4t_z828,4
 atomicshop/wrappers/configparserw.py,sha256=JwDTPjZoSrv44YKwIRcjyUnpN-FjgXVfMqMK_tJuSgU,22800
 atomicshop/wrappers/cryptographyw.py,sha256=H5NaHHDkr97QYhUrHFO9vY218u8k3N3Zgh6bQRnicUE,13140
 atomicshop/wrappers/ffmpegw.py,sha256=wcq0ZnAe0yajBOuTKZCCaKI7CDBjkq7FAgdW5IsKcVE,6031
-atomicshop/wrappers/githubw.py,sha256=AjD0VUlV2Kcddns2OaGmyX-FOAvdps-8SPSWS05E0QA,4809
+atomicshop/wrappers/githubw.py,sha256=mQGtj6up1HIvjOD2t0bmOWjLooJLYvuIa7d7H-tknrw,9998
 atomicshop/wrappers/numpyw.py,sha256=sBV4gSKyr23kXTalqAb1oqttzE_2XxBooCui66jbAqc,1025
 atomicshop/wrappers/process_wrapper_pbtk.py,sha256=ycPmBRnv627RWks6N8OhxJQe8Gu3h3Vwj-4HswPOw0k,599
 atomicshop/wrappers/pyopensslw.py,sha256=OBWxA6EJ2vU_Qlf4M8m6ilcG3hyYB4yB0EsXUf7NhEU,6804
@@ -156,10 +156,10 @@ atomicshop/wrappers/dockerw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 atomicshop/wrappers/dockerw/dockerw.py,sha256=w8zSJr5C7cbvbuG09ORCpAe0BOcibqqL_Z2EKEBHYK4,6266
 atomicshop/wrappers/dockerw/install_docker.py,sha256=eF0raR1EO9Xk1MVH7CvtkFI2Fgu9zL12MIYV_1vPTQk,4799
 atomicshop/wrappers/elasticsearchw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/wrappers/elasticsearchw/config_basic.py,sha256=XJMKKfDrUq9ZKxYnQ-xFJxSA51z31Nn4eB8_n_hryVk,800
+atomicshop/wrappers/elasticsearchw/config_basic.py,sha256=q9Ybr8TTeNPy6FxtiYCln8WNuwOQjdPazTRoGl7Lk8w,1066
 atomicshop/wrappers/elasticsearchw/elasticsearchw.py,sha256=7TqFdEFznO8NlligJhEKk1vm641ALpCYdaRl1uoXdzM,9768
-atomicshop/wrappers/elasticsearchw/infrastructure.py,sha256=J1hKIEQA8ImRUmkM25fbmwHbZPC9VnT9NK1_kOfXitA,8311
-atomicshop/wrappers/elasticsearchw/install_elastic.py,sha256=EeMZ2zSZIE3bvQ3HHJ4ed2TXLg1ufwKlDon79X5mhIU,8467
+atomicshop/wrappers/elasticsearchw/infrastructure.py,sha256=Sy15gLVe_LAk9WpAoFxu5YApecFlYeJzzJ8lk5NYQEw,9217
+atomicshop/wrappers/elasticsearchw/install_elastic.py,sha256=5CNgIoPIDnTCk5kU7Zcyb48TP4JScvUzeZmhcWt63sI,8754
 atomicshop/wrappers/elasticsearchw/queries/__init__.py,sha256=KBjT-bAt75CJsx1Apko9mpuFU4pfZV8DcGWQvpX65RU,78
 atomicshop/wrappers/elasticsearchw/queries/aggregation.py,sha256=N9a5yMMnb10sMa_x1qJBFQpgyJ49UWo8_vxuqmUtZ1A,1742
 atomicshop/wrappers/elasticsearchw/queries/info.py,sha256=P_VhhBo8MvRI4Shi-bh4RsYtlYNRKRBzScXPC64Up_Q,2900
@@ -199,7 +199,7 @@ atomicshop/wrappers/loggingw/loggers.py,sha256=DHOOTAtqkwn1xgvLHSkOiBm6yFGNuQy1k
 atomicshop/wrappers/loggingw/loggingw.py,sha256=v9WAseZXB50LluT9rIUcRvvevg2nLVKPgz3dbGejfV0,12151
 atomicshop/wrappers/loggingw/reading.py,sha256=xs7L6Jo-vedrhCVP7m-cJo0VhWmoSoK86avR4Tm0kG4,3675
 atomicshop/wrappers/nodejsw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/wrappers/nodejsw/install_nodejs.py,sha256=an7zX_sEG4CF57tdeR3jldDSNnS8Z4vRfSY9y1OjF4g,1440
+atomicshop/wrappers/nodejsw/install_nodejs.py,sha256=tHJQHpnK-QVrdbbUN3gz_6gklX5c6w1ERRgZ8efn4Bo,4794
 atomicshop/wrappers/playwrightw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/playwrightw/_tryouts.py,sha256=l1BLkFsiIMNlgv7nfZd1XGEvXQkIQkIcg48__9OaC00,4920
 atomicshop/wrappers/playwrightw/base.py,sha256=WeRpx8otdXuKSr-BjY-uCJTze21kbPpfitoOjKQz5-g,9818
@@ -232,8 +232,8 @@ atomicshop/wrappers/socketw/socket_server_tester.py,sha256=AhpurHJmP2kgzHaUbq5ey
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=aXBwlEIJhFT0-c4i8iNlFx2It9VpCEpsv--5Oqcpxao,11624
 atomicshop/wrappers/socketw/ssl_base.py,sha256=k4V3gwkbq10MvOH4btU4onLX2GNOsSfUAdcHmL1rpVE,2274
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=t3dtDEfN47CfYVi0CW6Kc2QHTEeZVyYhc57IYYh5nmA,826
-atomicshop-2.9.33.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.9.33.dist-info/METADATA,sha256=xhGDHuJiZxOFiXby5r0kKvwrMjy6bJN59Vx0ynMYkFU,10423
-atomicshop-2.9.33.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.9.33.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.9.33.dist-info/RECORD,,
+atomicshop-2.10.0.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.10.0.dist-info/METADATA,sha256=FI-w5jz9h06C_vDlRS0qjGL9g7eA8xhcjhugwE74Da4,10423
+atomicshop-2.10.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.10.0.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.10.0.dist-info/RECORD,,