def add(stub_name, force=False):
"""Add Stubs from package or path
\b
In general, stub package names follow this schema:
<device>-<firmware>-<version>
\b
For example:
esp32-micropython-1.11.0
\b
You can search premade stub packages using:
micropy stubs search <QUERY>
Checkout the docs on Github for more info.
"""
mp = MicroPy()
mp.STUBS.verbose_log(True)
proj = Project('.', stub_manager=mp.STUBS)
mp.log.title(f"Adding $[{stub_name}] to stubs")
try:
stub = mp.STUBS.add(stub_name, force=force)
except exc.StubNotFound:
mp.log.error(f"$[{stub_name}] could not be found!")
sys.exit(1)
except exc.StubError:
mp.log.error(f"$[{stub_name}] is not a valid stub!")
sys.exit(1)
else:
if proj.exists():
mp.log.title(f"Adding $[{stub.name}] to $[{proj.name}]")
proj.add_stub(stub)
def init(path, name=None, template=None):
"""Create new Micropython Project
\b
When creating a new project, all files will be
placed under the generated <PROJECT_NAME> folder.
"""
mp = MicroPy()
mp.log.title("Creating New Project")
if not path:
path = Path.cwd()
default_name = path.name
prompt_name = prompt.text("Project Name", default=default_name).ask()
name = prompt_name.strip()
if not template:
templ_choices = [Choice(str(val[1]), value=t)
for t, val in Project.TEMPLATES.items()]
template = prompt.checkbox(
f"Choose any Templates to Generate", choices=templ_choices).ask()
stubs = [Choice(str(s), value=s) for s in mp.STUBS]
if not stubs:
mp.log.error("You don't have any stubs!")
mp.log.title(
"To add stubs to micropy, use $[micropy stubs add <STUB_NAME>]")
sys.exit(1)
stub_choices = prompt.checkbox(
f"Which stubs would you like to use?", choices=stubs).ask()
project = Project(path,
name=name,
templates=template,
stubs=stub_choices,
stub_manager=mp.STUBS)
proj_relative = project.create()
mp.log.title(f"Created $w[{project.name}] at $w[./{proj_relative}]")
def cli(ctx):
"""CLI Application for creating/managing Micropython Projects."""
if ctx.invoked_subcommand is None:
proj = Project.resolve('.')
if not proj:
return click.echo(ctx.get_help())
latest = utils.is_update_available()
if latest:
log = Log.get_logger('MicroPy')
log.title("Update Available!")
log.info(f"Version $B[v{latest}] is now available")
log.info(
"You can update via: $[pip install --upgrade micropy-cli]\n")
def list():
"""List installed stubs"""
def print_stubs(stub_list):
for firm, stubs in stub_list:
if stubs:
title = str(firm).capitalize()
mp.log.title(f"$[{title}]:")
for stub in stubs:
mp.log.info(str(stub))
mp = MicroPy()
mp.log.title("Installed Stubs:")
mp.log.info(f"Total: {len(mp.STUBS)}")
print_stubs(mp.STUBS.iter_by_firmware())
proj = Project.resolve('.', verbose=False)
if proj:
mp.log.title(f"Stubs used in {proj.name}:")
mp.log.info(f"Total: {len(proj.stubs)}")
stubs = mp.STUBS.iter_by_firmware(stubs=proj.stubs)
print_stubs(stubs)
def install(packages, dev=False):
"""Install Packages as Project Requirements
\b
Installing a package via micropy will stub it, enabling
intellisense, autocompletion, and linting for it.
\b
If no packages are passed and a requirements.txt file is found,
then micropy will install all packages listed in it.
\b
If the --dev flag is passed, then the packages are only
added to micropy.json. They are not stubbed.
\b
You can import installed packages just as you would
on your actual device:
\b
# main.py
import <package_name>
"""
mp = MicroPy()
project = Project.resolve('.')
if not project:
mp.log.error("You are not currently in an active project!")
sys.exit(1)
if not packages:
mp.log.title("Installing all Requirements")
reqs = project.add_from_requirements()
if not reqs:
mp.log.error("No requirements.txt file found!")
sys.exit(1)
mp.log.success("\nRequirements Installed!")
sys.exit(0)
mp.log.title("Installing Packages")
for pkg in packages:
project.add_package(pkg, dev=dev)
def resolve_project(self, path, verbose=True):
"""Returns project from path if it exists.
Args:
path (str): Path to test
verbose (bool): Log to stdout. Defaults to True.
Returns:
Project if it exists
"""
path = Path(path).absolute()
proj = Project(path)
proj.add(modules.StubsModule, self.stubs)
proj.add(modules.PackagesModule, 'requirements.txt')
proj.add(modules.DevPackagesModule, 'dev-requirements.txt')
proj.add(modules.TemplatesModule, run_checks=self.RUN_CHECKS)
if proj.exists:
if verbose:
self.log.title(f"Loading Project")
proj.load()
if verbose:
self.log.success("Ready!")
return proj
return proj
def init(mpy, path, name=None, template=None):
"""Create new Micropython Project.
\b When creating a new project, all files will be placed under the
generated <PROJECT_NAME> folder.
"""
mpy.log.title("Creating New Project")
if not path:
path = Path.cwd()
default_name = path.name
prompt_name = prompt.text("Project Name", default=default_name).ask()
name = prompt_name.strip()
if not template:
templates = modules.TemplatesModule.TEMPLATES.items()
templ_choices = [Choice(str(val[1]), value=t)
for t, val in templates]
template = prompt.checkbox(
f"Choose any Templates to Generate", choices=templ_choices).ask()
stubs = [Choice(str(s), value=s) for s in mpy.stubs]
if not stubs:
mpy.log.error("You don't have any stubs!")
mpy.log.title(
"To add stubs to micropy, use $[micropy stubs add <STUB_NAME>]")
sys.exit(1)
stub_choices = prompt.checkbox(
f"Which stubs would you like to use?", choices=stubs).ask()
project = Project(path, name=name)
project.add(modules.StubsModule, mpy.stubs, stubs=stub_choices)
project.add(modules.PackagesModule, 'requirements.txt')
project.add(modules.DevPackagesModule, 'dev-requirements.txt')
project.add(modules.TemplatesModule, templates=template, run_checks=mpy.RUN_CHECKS)
proj_path = project.create()
try:
rel_path = f"./{proj_path.relative_to(Path.cwd())}"
except ValueError:
rel_path = proj_path
mpy.log.title(f"Created $w[{project.name}] at $w[{rel_path}]")