Merge branch 'release/v1.0.0'

Author: ivankravets

.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2

get-platformio.py

@@ -14,16 +14,17 @@
 
 import logging.config
 
-VERSION = (0, 3, 5)
+VERSION = (1, 0, 0)
 __version__ = ".".join([str(s) for s in VERSION])
 
 __title__ = "platformio-installer"
 __description__ = "An installer for PlatformIO Core"
 
 __url__ = "https://platformio.org"
 
-__author__ = "PlatformIO"
-__email__ = "[email protected]"
+__author__ = "PlatformIO Labs"
+__email__ = "[email protected]"
+
 
 __license__ = "Apache-2.0"
 __copyright__ = "Copyright 2014-present PlatformIO"

pioinstaller/__init__.py

@@ -36,22 +36,31 @@
     multiple=True,
     help="A path to Python to be ignored (multiple options and unix wildcards are allowed)",
 )
+@click.option(
+    "--pypi-index-url",
+    help="Custom base URL of the Python Package Index (default `https://pypi.org/simple)`",
+)
 @click.pass_context
 def cli(
-    ctx, verbose, shutdown_piohome, dev, ignore_python
+    ctx, verbose, shutdown_piohome, dev, ignore_python, pypi_index_url
 ):  # pylint:disable=too-many-arguments
     if verbose:
         logging.getLogger("pioinstaller").setLevel(logging.DEBUG)
+    if pypi_index_url:
+        os.environ["PIP_INDEX_URL"] = pypi_index_url
     ctx.obj["dev"] = dev
-    if not ctx.invoked_subcommand:
-        click.echo("Installer version: %s" % __version__)
-        click.echo("Platform: %s" % platform.platform(terse=True))
-        click.echo("Python version: %s" % sys.version)
-        click.echo("Python path: %s" % sys.executable)
-        try:
-            core.install_platformio_core(shutdown_piohome, dev, ignore_python)
-        except exception.PIOInstallerException as e:
-            raise click.ClickException(str(e))
+    if ctx.invoked_subcommand:
+        return
+
+    click.echo("Installer version: %s" % __version__)
+    click.echo("Platform: %s" % platform.platform(terse=True))
+    click.echo("Python version: %s" % sys.version)
+    click.echo("Python path: %s" % sys.executable)
+
+    try:
+        core.install_platformio_core(shutdown_piohome, dev, ignore_python)
+    except exception.PIOInstallerException as exc:
+        raise click.ClickException(str(exc))
 
 
 @cli.command()

pioinstaller/__main__.py

@@ -30,24 +30,24 @@
 UPDATE_INTERVAL = 60 * 60 * 24 * 3  # 3 days
 
 
-def get_core_dir():
+def get_core_dir(force_to_root=False):
     if os.getenv("PLATFORMIO_CORE_DIR"):
         return os.getenv("PLATFORMIO_CORE_DIR")
 
     core_dir = os.path.join(util.expanduser("~"), ".platformio")
     if not util.IS_WINDOWS:
         return core_dir
 
-    win_core_dir = os.path.splitdrive(core_dir)[0] + "\\.platformio"
-    if os.path.isdir(win_core_dir):
-        return win_core_dir
+    win_root_dir = os.path.splitdrive(core_dir)[0] + "\\.platformio"
+    if os.path.isdir(win_root_dir):
+        return win_root_dir
     try:
-        if util.has_non_ascii_char(core_dir):
-            os.makedirs(win_core_dir)
-            with open(os.path.join(win_core_dir, "file.tmp"), "w") as fp:
+        if util.has_non_ascii_char(core_dir) or force_to_root:
+            os.makedirs(win_root_dir)
+            with open(os.path.join(win_root_dir, "file.tmp"), "w") as fp:
                 fp.write("test")
-            os.remove(os.path.join(win_core_dir, "file.tmp"))
-            return win_core_dir
+            os.remove(os.path.join(win_root_dir, "file.tmp"))
+            return win_root_dir
     except:  # pylint:disable=bare-except
         pass
 
@@ -63,6 +63,29 @@ def get_cache_dir(path=None):
 
 
 def install_platformio_core(shutdown_piohome=True, develop=False, ignore_pythons=None):
+    try:
+        return _install_platformio_core(
+            shutdown_piohome=shutdown_piohome,
+            develop=develop,
+            ignore_pythons=ignore_pythons,
+        )
+    except subprocess.CalledProcessError as exc:
+        # Issue #221: Workaround for Windows OS when username contains a space
+        # https://github.com/platformio/platformio-core-installer/issues/221
+        if (
+            util.IS_WINDOWS
+            and " " in get_core_dir()
+            and " " not in get_core_dir(force_to_root=True)
+        ):
+            return _install_platformio_core(
+                shutdown_piohome=shutdown_piohome,
+                develop=develop,
+                ignore_pythons=ignore_pythons,
+            )
+        raise exc
+
+
+def _install_platformio_core(shutdown_piohome=True, develop=False, ignore_pythons=None):
     # pylint: disable=bad-option-value, import-outside-toplevel, unused-import, import-error, unused-variable, cyclic-import
     from pioinstaller import penv
 
@@ -96,10 +119,6 @@ def install_platformio_core(shutdown_piohome=True, develop=False, ignore_pythons
         penv.get_penv_bin_dir(penv_dir),
         "platformio.exe" if util.IS_WINDOWS else "platformio",
     )
-    try:
-        home.install_pio_home(platformio_exe)
-    except Exception as e:  # pylint:disable=broad-except
-        log.debug(e)
 
     click.secho(
         "\nPlatformIO Core has been successfully installed into an isolated environment `%s`!\n"
@@ -126,7 +145,8 @@ def check(dev=False, auto_upgrade=False, version_spec=None):
     from pioinstaller import penv
 
     platformio_exe = os.path.join(
-        penv.get_penv_bin_dir(), "platformio.exe" if util.IS_WINDOWS else "platformio",
+        penv.get_penv_bin_dir(),
+        "platformio.exe" if util.IS_WINDOWS else "platformio",
     )
     python_exe = os.path.join(
         penv.get_penv_bin_dir(), "python.exe" if util.IS_WINDOWS else "python"
@@ -185,7 +205,8 @@ def check(dev=False, auto_upgrade=False, version_spec=None):
         penv_state = json.load(fp)
         if penv_state.get("platform") != platform.platform(terse=True):
             raise exception.InvalidPlatformIOCore(
-                "PlatformIO installed using another platform `%s`. Your platform: %s"
+                "PlatformIO Core was installed using another platform `%s`. "
+                "Your current platform: %s"
                 % (penv_state.get("platform"), platform.platform(terse=True))
             )
 
@@ -227,18 +248,33 @@ def check(dev=False, auto_upgrade=False, version_spec=None):
 
 
 def fetch_python_state(python_exe):
-    code = """import platform
+    code = """
 import json
+import platform
+import sys
+
 import platformio
 
+if sys.version_info < (3, 6):
+    raise Exception(
+        "Unsupported Python version: %s. "
+        "Minimum supported Python version is 3.6 or above."
+        % platform.python_version(),
+    )
+
 state = {
    "core_version": platformio.__version__,
    "python_version": platform.python_version()
 }
 print(json.dumps(state))
 """
     state = subprocess.check_output(
-        [python_exe, "-c", code,], stderr=subprocess.STDOUT,
+        [
+            python_exe,
+            "-c",
+            code,
+        ],
+        stderr=subprocess.STDOUT,
     )
     return json.loads(state.decode())
 
@@ -256,7 +292,8 @@ def upgrade_core(platformio_exe, dev=False):
         command.append("--dev")
     try:
         subprocess.check_output(
-            command, stderr=subprocess.PIPE,
+            command,
+            stderr=subprocess.PIPE,
         )
         return True
     except Exception as e:  # pylint:disable=broad-except

pioinstaller/core.py

@@ -14,12 +14,9 @@
 
 import logging
 import multiprocessing
-import subprocess
 
 import requests
 
-from pioinstaller import exception
-
 HTTP_HOST = "127.0.0.1"
 HTTP_PORT_BEGIN = 8008
 HTTP_PORT_END = 8050
@@ -44,14 +41,3 @@ def shutdown_pio_home_servers():
     proc.join(10)
     proc.terminate()
     return True
-
-
-def install_pio_home(platformio_exe):
-    try:
-        subprocess.check_output(
-            [platformio_exe, "home", "--host", "__do_not_start__"],
-            stderr=subprocess.PIPE,
-        )
-        return True
-    except Exception as e:  # pylint:disable=broad-except
-        raise exception.PIOInstallerException("Could not install PIO Home: %s" % str(e))

pioinstaller/home.py

@@ -92,7 +92,8 @@ def create_virtualenv(python_exe, penv_dir):
             return create_with_remote_venv(python_exe, penv_dir)
         except Exception as e:  # pylint:disable=broad-except
             log.debug(
-                "Could not create virtualenv with downloaded script. Error: %s", str(e),
+                "Could not create virtualenv with downloaded script. Error: %s",
+                str(e),
             )
 
 
@@ -148,7 +149,10 @@ def add_state_info(python_exe, penv_dir):
     )
     state = {
         "created_on": int(round(time.time())),
-        "python": {"path": python_exe, "version": python_version,},
+        "python": {
+            "path": python_exe,
+            "version": python_version,
+        },
         "installer_version": __version__,
         "platform": platform.platform(terse=True),
     }
@@ -176,6 +180,7 @@ def install_pip(python_exe, penv_dir):
         return True
     except Exception as e:  # pylint:disable=broad-except
         log.debug(
-            "Could not install pip. Error: %s", str(e),
+            "Could not install pip. Error: %s",
+            str(e),
         )
         return False

pioinstaller/penv.py

@@ -48,10 +48,10 @@ def is_conda():
         [
             os.path.exists(os.path.join(sys.prefix, "conda-meta")),
             # (os.getenv("CONDA_PREFIX") or os.getenv("CONDA_DEFAULT_ENV")),
-            "anaconda" in sys.executable,
-            "miniconda" in sys.executable,
-            "Continuum Analytics" in sys.version,
-            "conda" in sys.version,
+            "anaconda" in sys.executable.lower(),
+            "miniconda" in sys.executable.lower(),
+            "continuum analytics" in sys.version.lower(),
+            "conda" in sys.version.lower(),
         ]
     )
 
@@ -93,15 +93,13 @@ def fetch_portable_python(dst):
 def check():
     # platform check
     if sys.platform == "cygwin":
-        raise exception.IncompatiblePythonError("Unsupported cygwin platform")
+        raise exception.IncompatiblePythonError("Unsupported Cygwin platform")
 
     # version check
-    if not (
-        sys.version_info >= (2, 7, 9) and sys.version_info < (3,)
-    ) and not sys.version_info >= (3, 5):
+    if sys.version_info < (3, 6):
         raise exception.IncompatiblePythonError(
-            "Unsupported python version: %s. "
-            "Supported version: >= 2.7.9 and < 3, or >= 3.5"
+            "Unsupported Python version: %s. "
+            "Minimum supported Python version is 3.6 or above."
             % platform.python_version(),
         )
 
@@ -116,7 +114,7 @@ def check():
 
     # portable Python 3 for macOS is not compatible with macOS < 10.13
     # https://github.com/platformio/platformio-core-installer/issues/70
-    if util.IS_MACOS and sys.version_info >= (3, 5):
+    if util.IS_MACOS:
         with tempfile.NamedTemporaryFile() as tmpfile:
             os.utime(tmpfile.name)
 
@@ -142,11 +140,13 @@ def check():
     return True
 
 
-def find_compatible_pythons(ignore_pythons=None):  # pylint: disable=too-many-branches
+def find_compatible_pythons(
+    ignore_pythons=None, raise_exception=True
+):  # pylint: disable=too-many-branches
     ignore_list = []
     for p in ignore_pythons or []:
         ignore_list.extend(glob.glob(p))
-    exenames = ["python3", "python", "python2"]
+    exenames = ["python3", "python"]
     if util.IS_WINDOWS:
         exenames = ["%s.exe" % item for item in exenames]
     log.debug("Current environment PATH %s", os.getenv("PATH"))
@@ -195,8 +195,16 @@ def find_compatible_pythons(ignore_pythons=None):  # pylint: disable=too-many-br
                     """Can not install PlatformIO Core due to a missed `distutils` package in your Python installation.
 Please install this package manually using the OS package manager. For example:
 
-$ apt-get install python3-distutils
+$ apt-get install python3-venv
 
 (MAY require administrator access `sudo`)""",
                 )
+
+    if not result and raise_exception:
+        raise exception.IncompatiblePythonError(
+            "Could not find compatible Python 3.6 or above in your system."
+            "Please install the latest official Python 3 and restart installation:\n"
+            "https://docs.platformio.org/page/faq.html#install-python-interpreter"
+        )
+
     return result

pioinstaller/python.py

@@ -36,12 +36,12 @@
     install_requires=[
         # Core
         "click==7.1.2",
-        "requests==2.24.0",
-        "colorama==0.4.3",
+        "requests==2.25.1",
+        "colorama==0.4.4",
         "semantic-version==2.8.5",
-        "certifi==2020.6.20",
+        "certifi==2020.12.5",
         # Misc
-        "wheel==0.35.1",
+        "wheel==0.36.2",
     ],
     packages=find_packages(),
     entry_points={

setup.py

@@ -60,9 +60,3 @@ def test_install_pio_core(pio_installer_script, tmpdir, monkeypatch):
             "platformio.exe" if util.IS_WINDOWS else "platformio",
         )
     )
-    assert os.path.isfile(
-        os.path.join(str(core_dir), "packages", "contrib-piohome", "package.json")
-    )
-    assert os.path.isfile(
-        os.path.join(str(core_dir), "packages", "contrib-pysite", "package.json")
-    )