1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
# pylint: disable=import-outside-toplevel
import os
import sys
import click
from lektor.cli_utils import AliasedGroup
from lektor.cli_utils import extraflag
from lektor.cli_utils import pass_context
from lektor.packages import get_package_info
from lektor.packages import publish_package
from lektor.packages import register_package
try:
from IPython import embed
from traitlets.config.loader import Config
except ImportError:
pass # fallback to normal Python InteractiveConsole
def ensure_plugin():
here = os.getcwd()
if not os.path.isfile(os.path.join(here, "setup.py")):
raise click.UsageError("This command must be run in a " "Lektor plugin folder")
info = get_package_info(here)
if not info["name"].lower().startswith("lektor-"):
raise click.UsageError(
"Python package is misnamed. Needs to start " "with lektor-"
)
return info
@click.group(cls=AliasedGroup, short_help="Development commands.")
def cli():
"""Development commands for Lektor.
This provides various development support commands for Lektor. This is
primarily useful for Lektor plugin development but also if you want to
extend Lektor itself. Additional functionality can be unlocked by
exporting the `LEKTOR_DEV=1` environment variable.
"""
@cli.command("shell", short_help="Starts a python shell.")
@extraflag
@pass_context
def shell_cmd(ctx, extra_flags):
"""Starts a Python shell in the context of a Lektor project.
This is particularly useful for debugging plugins and to explore the
API. To quit the shell just use `quit()`. Within the shell various
utilities are available right from the get-go for you.
\b
- `project`: the loaded project as object.
- `env`: an environment for the loaded project.
- `pad`: a database pad initialized for the project and environment
that is ready to use.
"""
ctx.load_plugins(extra_flags=extra_flags)
import code
from lektor.db import F, Tree
from lektor.builder import Builder
banner = "Python %s on %s\nLektor Project: %s" % (
sys.version,
sys.platform,
ctx.get_env().root_path,
)
ns = {}
startup = os.environ.get("PYTHONSTARTUP")
if startup and os.path.isfile(startup):
with open(startup, "r", encoding="utf-8") as f:
eval(compile(f.read(), startup, "exec"), ns) # pylint: disable=eval-used
pad = ctx.get_env().new_pad()
ns.update(
project=ctx.get_project(),
env=ctx.get_env(),
pad=pad,
tree=Tree(pad),
config=ctx.get_env().load_config(),
make_builder=lambda: Builder(
ctx.get_env().new_pad(), ctx.get_default_output_path()
),
F=F,
)
try:
c = Config()
c.TerminalInteractiveShell.banner2 = banner
embed(config=c, user_ns=ns)
except NameError: # No IPython
code.interact(banner=banner, local=ns)
@cli.command("publish-plugin", short_help="Publish a plugin to PyPI.")
def publish_plugin_cmd():
"""Publishes the current version of the plugin in the current folder.
This generally requires that your setup.py has at least the bare minimum
configuration for valid publishing to PyPI.
"""
info = ensure_plugin()
for key in "author", "author_email", "license", "url":
if not info[key]:
raise click.UsageError(
"Cannot publish plugin without setting " '"%s" in setup.py.' % key
)
register_package(info["path"])
publish_package(info["path"])
@cli.command("new-plugin", short_help="Creates a new plugin")
@click.option("--path", type=click.Path(), help="The destination path")
@click.argument("plugin_name", required=False)
@pass_context
def new_plugin(ctx, **defaults):
"""This command creates a new plugin.
This will present you with a very short wizard that guides you through
creation of a new plugin. At the end of it, it will create a plugin
in the packages folder of the current project or the path you defined.
This is the fastest way to creating a new plugin.
"""
from .quickstart import plugin_quickstart
project = ctx.get_project(silent=True)
plugin_quickstart(defaults, project=project)
@cli.command("new-theme", short_help="Creates a new theme")
@click.option("--path", type=click.Path(), help="The destination path")
@click.argument("theme_name", required=False)
@pass_context
def new_theme(ctx, **defaults):
"""This command creates a new theme.
This will present you with a very short wizard that guides you through
creation of a new theme. At the end of it, it will create a theme
in the packages folder of the current project or the path you defined.
This is the fastest way to creating a new theme.
"""
from .quickstart import theme_quickstart
project = ctx.get_project(silent=True)
theme_quickstart(defaults, project=project)
|
