forked from platformio/platformio-core
251 lines
8.8 KiB
Python
251 lines
8.8 KiB
Python
# Copyright 2014-present PlatformIO <contact@platformio.org>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import json
|
|
|
|
import click
|
|
|
|
from platformio import app, exception, util
|
|
from platformio.managers.platform import PlatformFactory, PlatformManager
|
|
|
|
|
|
@click.group(short_help="Platform Manager")
|
|
def cli():
|
|
pass
|
|
|
|
|
|
def _print_platforms(platforms):
|
|
for platform in platforms:
|
|
click.echo("{name} ~ {title}".format(
|
|
name=click.style(platform['name'], fg="cyan"),
|
|
title=platform['title']))
|
|
click.echo("=" * (3 + len(platform['name'] + platform['title'])))
|
|
click.echo(platform['description'])
|
|
click.echo()
|
|
if "homepage" in platform:
|
|
click.echo("Home: %s" % platform['homepage'])
|
|
if "packages" in platform:
|
|
click.echo("Packages: %s" % ", ".join(platform['packages']))
|
|
if "version" in platform:
|
|
click.echo("Version: " + platform['version'])
|
|
click.echo()
|
|
|
|
|
|
@cli.command("search", short_help="Search for development platform")
|
|
@click.argument("query", required=False)
|
|
@click.option("--json-output", is_flag=True)
|
|
def platform_search(query, json_output):
|
|
platforms = []
|
|
for platform in util.get_api_result("/platforms", cache_valid="30d"):
|
|
if query == "all":
|
|
query = ""
|
|
search_data = json.dumps(platform)
|
|
if query and query.lower() not in search_data.lower():
|
|
continue
|
|
platform['homepage'] = (
|
|
"http://platformio.org/platforms/" + platform['name'])
|
|
del platform['version']
|
|
platforms.append(platform)
|
|
|
|
if json_output:
|
|
click.echo(json.dumps(platforms))
|
|
else:
|
|
_print_platforms(platforms)
|
|
|
|
|
|
@cli.command("frameworks", short_help="List supported frameworks, SDKs")
|
|
@click.argument("query", required=False)
|
|
@click.option("--json-output", is_flag=True)
|
|
def platform_frameworks(query, json_output):
|
|
frameworks = []
|
|
for framework in util.get_api_result("/frameworks", cache_valid="30d"):
|
|
if query == "all":
|
|
query = ""
|
|
search_data = json.dumps(framework)
|
|
if query and query.lower() not in search_data.lower():
|
|
continue
|
|
framework['homepage'] = (
|
|
"http://platformio.org/frameworks/" + framework['name'])
|
|
frameworks.append(framework)
|
|
|
|
if json_output:
|
|
click.echo(json.dumps(frameworks))
|
|
else:
|
|
_print_platforms(frameworks)
|
|
|
|
|
|
@cli.command("install", short_help="Install new development platform")
|
|
@click.argument("platforms", nargs=-1, required=True, metavar="[PLATFORM...]")
|
|
@click.option("--with-package", multiple=True)
|
|
@click.option("--without-package", multiple=True)
|
|
@click.option("--skip-default-package", is_flag=True)
|
|
def platform_install(platforms, with_package, without_package,
|
|
skip_default_package):
|
|
pm = PlatformManager()
|
|
for platform in platforms:
|
|
if pm.install(
|
|
name=platform,
|
|
with_packages=with_package,
|
|
without_packages=without_package,
|
|
skip_default_package=skip_default_package):
|
|
click.secho(
|
|
"The platform '%s' has been successfully installed!\n"
|
|
"The rest of packages will be installed automatically "
|
|
"depending on your build environment." % platform,
|
|
fg="green")
|
|
|
|
|
|
@cli.command("uninstall", short_help="Uninstall development platform")
|
|
@click.argument("platforms", nargs=-1, required=True, metavar="[PLATFORM...]")
|
|
def platform_uninstall(platforms):
|
|
pm = PlatformManager()
|
|
for platform in platforms:
|
|
if pm.uninstall(platform):
|
|
click.secho(
|
|
"The platform '%s' has been successfully "
|
|
"uninstalled!" % platform,
|
|
fg="green")
|
|
|
|
|
|
@cli.command("update", short_help="Update installed development platforms")
|
|
@click.argument("platforms", nargs=-1, required=False, metavar="[PLATFORM...]")
|
|
@click.option(
|
|
"-p",
|
|
"--only-packages",
|
|
is_flag=True,
|
|
help="Update only platform packages")
|
|
@click.option(
|
|
"-c",
|
|
"--only-check",
|
|
is_flag=True,
|
|
help="Do not update, only check for new version")
|
|
@click.option("--json-output", is_flag=True)
|
|
def platform_update(platforms, only_packages, only_check, json_output):
|
|
# cleanup cached board and platform lists
|
|
app.clean_cache()
|
|
|
|
pm = PlatformManager()
|
|
if not platforms:
|
|
platforms = []
|
|
for manifest in pm.get_installed():
|
|
pkg_dir = manifest['__pkg_dir']
|
|
if "@" in pkg_dir and "@vcs-" not in pkg_dir:
|
|
continue
|
|
elif "@vcs-" in pkg_dir:
|
|
platforms.append("%s=%s" % (manifest['name'], manifest['url']))
|
|
else:
|
|
platforms.append(manifest['name'])
|
|
|
|
if only_check and json_output:
|
|
result = []
|
|
for platform in platforms:
|
|
name, requirements, url = pm.parse_pkg_name(platform)
|
|
latest = pm.outdated(name, requirements, url)
|
|
if latest is False:
|
|
continue
|
|
manifest = pm.load_manifest(
|
|
pm.get_package_dir(name, requirements, url))
|
|
manifest['versionLatest'] = latest or "Unknown"
|
|
result.append(manifest)
|
|
return click.echo(json.dumps(result))
|
|
else:
|
|
for platform in platforms:
|
|
click.echo("Platform %s" % click.style(platform, fg="cyan"))
|
|
click.echo("--------")
|
|
pm.update(
|
|
platform, only_packages=only_packages, only_check=only_check)
|
|
click.echo()
|
|
|
|
|
|
@cli.command("list", short_help="List installed development platforms")
|
|
@click.option("--json-output", is_flag=True)
|
|
def platform_list(json_output):
|
|
platforms = []
|
|
pm = PlatformManager()
|
|
for manifest in pm.get_installed():
|
|
p = PlatformFactory.newPlatform(
|
|
pm.get_manifest_path(manifest['__pkg_dir']))
|
|
platforms.append({
|
|
"name": p.name,
|
|
"title": p.title,
|
|
"description": p.description,
|
|
"version": p.version,
|
|
"url": p.vendor_url,
|
|
"homepage": p.homepage,
|
|
# "packages": p.packages.keys(), # dump all packages
|
|
"packages": p.get_installed_packages().keys(),
|
|
'forDesktop':
|
|
any([p.name.startswith(n) for n in ("native", "linux", "windows")])
|
|
})
|
|
|
|
if json_output:
|
|
click.echo(json.dumps(platforms))
|
|
else:
|
|
_print_platforms(platforms)
|
|
|
|
|
|
@cli.command("show", short_help="Show details about installed platform")
|
|
@click.argument("platform")
|
|
def platform_show(platform):
|
|
|
|
def _detail_version(version):
|
|
if version.count(".") != 2:
|
|
return version
|
|
_, y = version.split(".")[:2]
|
|
if int(y) < 100:
|
|
return version
|
|
if len(y) % 2 != 0:
|
|
y = "0" + y
|
|
parts = [str(int(y[i * 2:i * 2 + 2])) for i in range(len(y) / 2)]
|
|
return "%s (%s)" % (version, ".".join(parts))
|
|
|
|
try:
|
|
p = PlatformFactory.newPlatform(platform)
|
|
except exception.UnknownPlatform:
|
|
raise exception.PlatformNotInstalledYet(platform)
|
|
|
|
click.echo("{name} ~ {title}".format(
|
|
name=click.style(
|
|
p.name, fg="cyan"), title=p.title))
|
|
click.echo("=" * (3 + len(p.name + p.title)))
|
|
click.echo(p.description)
|
|
click.echo()
|
|
click.echo("Version: %s" % p.version)
|
|
if p.homepage:
|
|
click.echo("Home: %s" % p.homepage)
|
|
if p.license:
|
|
click.echo("License: %s" % p.license)
|
|
if p.frameworks:
|
|
click.echo("Frameworks: %s" % ", ".join(p.frameworks.keys()))
|
|
|
|
if not p.packages:
|
|
return
|
|
|
|
installed_pkgs = p.get_installed_packages()
|
|
for name, opts in p.packages.items():
|
|
click.echo()
|
|
click.echo("Package %s" % click.style(name, fg="yellow"))
|
|
click.echo("-" * (8 + len(name)))
|
|
if p.get_package_type(name):
|
|
click.echo("Type: %s" % p.get_package_type(name))
|
|
click.echo("Requirements: %s" % opts.get("version"))
|
|
click.echo("Installed: %s" % ("Yes" if name in installed_pkgs else
|
|
"No (optional)"))
|
|
if name in installed_pkgs:
|
|
for key, value in installed_pkgs[name].items():
|
|
if key in ("url", "version", "description"):
|
|
if key == "version":
|
|
value = _detail_version(value)
|
|
click.echo("%s: %s" % (key.title(), value))
|