Skip to content

Commit 2a01765

Browse files
monty-botmonty-bot
committed
🚀 releasing version 2.0.0 @ 2020-04-09 10:01
[skip ci]
1 parent bd1a30d commit 2a01765

12 files changed

+2074
-17
lines changed

‎CHANGELOG.md

+21
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,27 @@ beta releases are not included in this history. For a full list of all releases,
1111

1212
[//]: # (begin_release_notes)
1313

14+
"2.0.0" (2020-04-09)
15+
====================
16+
17+
Major changes
18+
-------------
19+
20+
- Refactored thoroughly. (#20200409)
21+
22+
23+
Bugfixes
24+
--------
25+
26+
- Remove unused `requirements.txt`. (#20200409)
27+
28+
29+
Misc
30+
----
31+
32+
- #20200409
33+
34+
1435
1.1.0 (2018-11-07)
1536
==================
1637

‎docs/api.html

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<!--
2+
-- Copyright (C) 2020 Arm Mbed. All rights reserved.
3+
-- SPDX-License-Identifier: Apache-2.0
4+
-->
5+
<!doctype html>
6+
<html lang="en">
7+
<head>
8+
<meta charset="utf-8">
9+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10+
<meta name="generator" content="pdoc 0.7.5" />
11+
<title>snippet.api API documentation</title>
12+
<meta name="description" content="Code Snippet APIs." />
13+
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
14+
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
15+
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
16+
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
17+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
18+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
19+
</head>
20+
<body>
21+
<main>
22+
<article id="content">
23+
<header>
24+
<h1 class="title">Module <code>snippet.api</code></h1>
25+
</header>
26+
<section id="section-intro">
27+
<p>Code Snippet APIs.</p>
28+
<details class="source">
29+
<summary>
30+
<span>Expand source code</span>
31+
</summary>
32+
<pre><code class="python">#
33+
# Copyright (C) 2020 Arm Mbed. All rights reserved.
34+
# SPDX-License-Identifier: Apache-2.0
35+
#
36+
&#34;&#34;&#34;Code Snippet APIs.&#34;&#34;&#34;
37+
import textwrap
38+
39+
from snippet import workflow, config
40+
from snippet._internal.logs import LOGGER
41+
42+
43+
def extract_code_snippets(config: config.Config) -&gt; None:
44+
&#34;&#34;&#34;Extracts code snippets according to configuration.&#34;&#34;&#34;
45+
LOGGER.debug(&#34;project directory is %r&#34;, config.project_root)
46+
examples, paths, failures = workflow.run(config)
47+
48+
if failures:
49+
LOGGER.error(
50+
&#34;failures:\n%s&#34;, textwrap.indent(&#34;\n&#34;.join(f&#34;{name}: {exc}&#34; for name, exc in failures), prefix=&#34; &#34;)
51+
)
52+
raise Exception(f&#34;There were %s failures!&#34; % len(failures))</code></pre>
53+
</details>
54+
</section>
55+
<section>
56+
</section>
57+
<section>
58+
</section>
59+
<section>
60+
<h2 class="section-title" id="header-functions">Functions</h2>
61+
<dl>
62+
<dt id="snippet.api.extract_code_snippets"><code class="name flex">
63+
<span>def <span class="ident">extract_code_snippets</span></span>(<span>config: <a title="snippet.config.Config" href="config.html#snippet.config.Config">Config</a>) -> NoneType</span>
64+
</code></dt>
65+
<dd>
66+
<section class="desc"><p>Extracts code snippets according to configuration.</p></section>
67+
<details class="source">
68+
<summary>
69+
<span>Expand source code</span>
70+
</summary>
71+
<pre><code class="python">def extract_code_snippets(config: config.Config) -&gt; None:
72+
&#34;&#34;&#34;Extracts code snippets according to configuration.&#34;&#34;&#34;
73+
LOGGER.debug(&#34;project directory is %r&#34;, config.project_root)
74+
examples, paths, failures = workflow.run(config)
75+
76+
if failures:
77+
LOGGER.error(
78+
&#34;failures:\n%s&#34;, textwrap.indent(&#34;\n&#34;.join(f&#34;{name}: {exc}&#34; for name, exc in failures), prefix=&#34; &#34;)
79+
)
80+
raise Exception(f&#34;There were %s failures!&#34; % len(failures))</code></pre>
81+
</details>
82+
</dd>
83+
</dl>
84+
</section>
85+
<section>
86+
</section>
87+
</article>
88+
<nav id="sidebar">
89+
<h1>Index</h1>
90+
<div class="toc">
91+
<ul></ul>
92+
</div>
93+
<ul id="index">
94+
<li><h3>Super-module</h3>
95+
<ul>
96+
<li><code><a title="snippet" href="index.html">snippet</a></code></li>
97+
</ul>
98+
</li>
99+
<li><h3><a href="#header-functions">Functions</a></h3>
100+
<ul class="">
101+
<li><code><a title="snippet.api.extract_code_snippets" href="#snippet.api.extract_code_snippets">extract_code_snippets</a></code></li>
102+
</ul>
103+
</li>
104+
</ul>
105+
</nav>
106+
</main>
107+
<footer id="footer">
108+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.5</a>.</p>
109+
</footer>
110+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
111+
<script>hljs.initHighlightingOnLoad()</script>
112+
</body>
113+
</html>

‎docs/cli.html

+162
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
<!--
2+
-- Copyright (C) 2020 Arm Mbed. All rights reserved.
3+
-- SPDX-License-Identifier: Apache-2.0
4+
-->
5+
<!doctype html>
6+
<html lang="en">
7+
<head>
8+
<meta charset="utf-8">
9+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
10+
<meta name="generator" content="pdoc 0.7.5" />
11+
<title>snippet.cli API documentation</title>
12+
<meta name="description" content="CLI definition." />
13+
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
14+
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
15+
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
16+
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
17+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
18+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
19+
</head>
20+
<body>
21+
<main>
22+
<article id="content">
23+
<header>
24+
<h1 class="title">Module <code>snippet.cli</code></h1>
25+
</header>
26+
<section id="section-intro">
27+
<p>CLI definition.</p>
28+
<details class="source">
29+
<summary>
30+
<span>Expand source code</span>
31+
</summary>
32+
<pre><code class="python">#
33+
# Copyright (C) 2020 Arm Mbed. All rights reserved.
34+
# SPDX-License-Identifier: Apache-2.0
35+
#
36+
&#34;&#34;&#34;CLI definition.&#34;&#34;&#34;
37+
import argparse
38+
39+
import os
40+
import sys
41+
import dotenv
42+
43+
from mbed_tools_lib.logging import set_log_level, MbedToolsHandler
44+
45+
from snippet import config
46+
from snippet.api import extract_code_snippets
47+
from snippet._internal.logs import LOGGER
48+
49+
50+
def main() -&gt; int:
51+
&#34;&#34;&#34;Script CLI.&#34;&#34;&#34;
52+
parser = argparse.ArgumentParser()
53+
parser.add_argument(&#34;--config&#34;, type=str, action=&#34;append&#34;, help=&#34;paths (or globs) to config files&#34;)
54+
parser.add_argument(
55+
&#34;dir&#34;,
56+
nargs=&#34;?&#34;,
57+
default=os.getcwd(),
58+
help=&#34;path to project root, used by any relative paths in loaded configs [cwd]&#34;,
59+
)
60+
parser.add_argument(
61+
&#34;-v&#34;,
62+
&#34;--verbose&#34;,
63+
action=&#34;count&#34;,
64+
default=0,
65+
help=&#34;Set the verbosity level, enter multiple times to increase verbosity.&#34;,
66+
)
67+
parser.add_argument(
68+
&#34;-t&#34;, &#34;--traceback&#34;, action=&#34;store_true&#34;, default=True, help=&#34;Show a traceback when an error is raised.&#34;
69+
)
70+
args = parser.parse_args()
71+
set_log_level(args.verbose)
72+
dotenv.load_dotenv(dotenv.find_dotenv(usecwd=True, raise_error_if_not_found=False))
73+
# Use the context manager to ensure tools exceptions (expected behaviour) are shown as messages to the user,
74+
# but all other exceptions (unexpected behaviour) are shown as errors.
75+
with MbedToolsHandler(LOGGER, args.traceback):
76+
extract_code_snippets(config.get_config(config_paths=args.config, project_root=args.dir,))
77+
return 0
78+
return 1
79+
80+
81+
if __name__ == &#34;__main__&#34;:
82+
sys.exit(main())</code></pre>
83+
</details>
84+
</section>
85+
<section>
86+
</section>
87+
<section>
88+
</section>
89+
<section>
90+
<h2 class="section-title" id="header-functions">Functions</h2>
91+
<dl>
92+
<dt id="snippet.cli.main"><code class="name flex">
93+
<span>def <span class="ident">main</span></span>(<span>) -> int</span>
94+
</code></dt>
95+
<dd>
96+
<section class="desc"><p>Script CLI.</p></section>
97+
<details class="source">
98+
<summary>
99+
<span>Expand source code</span>
100+
</summary>
101+
<pre><code class="python">def main() -&gt; int:
102+
&#34;&#34;&#34;Script CLI.&#34;&#34;&#34;
103+
parser = argparse.ArgumentParser()
104+
parser.add_argument(&#34;--config&#34;, type=str, action=&#34;append&#34;, help=&#34;paths (or globs) to config files&#34;)
105+
parser.add_argument(
106+
&#34;dir&#34;,
107+
nargs=&#34;?&#34;,
108+
default=os.getcwd(),
109+
help=&#34;path to project root, used by any relative paths in loaded configs [cwd]&#34;,
110+
)
111+
parser.add_argument(
112+
&#34;-v&#34;,
113+
&#34;--verbose&#34;,
114+
action=&#34;count&#34;,
115+
default=0,
116+
help=&#34;Set the verbosity level, enter multiple times to increase verbosity.&#34;,
117+
)
118+
parser.add_argument(
119+
&#34;-t&#34;, &#34;--traceback&#34;, action=&#34;store_true&#34;, default=True, help=&#34;Show a traceback when an error is raised.&#34;
120+
)
121+
args = parser.parse_args()
122+
set_log_level(args.verbose)
123+
dotenv.load_dotenv(dotenv.find_dotenv(usecwd=True, raise_error_if_not_found=False))
124+
# Use the context manager to ensure tools exceptions (expected behaviour) are shown as messages to the user,
125+
# but all other exceptions (unexpected behaviour) are shown as errors.
126+
with MbedToolsHandler(LOGGER, args.traceback):
127+
extract_code_snippets(config.get_config(config_paths=args.config, project_root=args.dir,))
128+
return 0
129+
return 1</code></pre>
130+
</details>
131+
</dd>
132+
</dl>
133+
</section>
134+
<section>
135+
</section>
136+
</article>
137+
<nav id="sidebar">
138+
<h1>Index</h1>
139+
<div class="toc">
140+
<ul></ul>
141+
</div>
142+
<ul id="index">
143+
<li><h3>Super-module</h3>
144+
<ul>
145+
<li><code><a title="snippet" href="index.html">snippet</a></code></li>
146+
</ul>
147+
</li>
148+
<li><h3><a href="#header-functions">Functions</a></h3>
149+
<ul class="">
150+
<li><code><a title="snippet.cli.main" href="#snippet.cli.main">main</a></code></li>
151+
</ul>
152+
</li>
153+
</ul>
154+
</nav>
155+
</main>
156+
<footer id="footer">
157+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.5</a>.</p>
158+
</footer>
159+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
160+
<script>hljs.initHighlightingOnLoad()</script>
161+
</body>
162+
</html>

0 commit comments

Comments
 (0)