Skip to content

Commit

Permalink
Deployed ee219cb with MkDocs version: 1.5.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Hallett committed Jul 31, 2023
1 parent a0de2f1 commit a51bf1c
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@


<link rel="icon" href="/clientele/assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.19">
<meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">



Expand Down
6 changes: 3 additions & 3 deletions CHANGELOG/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@



<link rel="canonical" href="https://beckett-software.github.io/clientele/CHANGELOG/">
<link rel="canonical" href="https://phalt.github.io/clientele/CHANGELOG/">


<link rel="prev" href="../examples/">


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.19">
<meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">



Expand Down Expand Up @@ -435,7 +435,7 @@ <h2 id="030">0.3.0</h2>
<li>Added a <code>constants.py</code> file to the output if one does not exist yet, which can be used to store values that you do not want to change between subsequent re-generations of the clientele client, such as the API base url.</li>
<li>Authentication patterns now use <code>constants.py</code> for constants values.</li>
<li>Removed <code>ipython</code> from package dependencies and moved to dev dependencies.</li>
<li>Documentation! <a href="https://beckett-software.github.io/clientele/">https://beckett-software.github.io/clientele/</a></li>
<li>Documentation! <a href="https://phalt.github.io/clientele/">https://phalt.github.io/clientele/</a></li>
</ul>
<h2 id="020">0.2.0</h2>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions compatibility/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@



<link rel="canonical" href="https://beckett-software.github.io/clientele/compatibility/">
<link rel="canonical" href="https://phalt.github.io/clientele/compatibility/">


<link rel="prev" href="../usage/">
Expand All @@ -17,7 +17,7 @@
<link rel="next" href="../examples/">

<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.19">
<meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">



Expand Down
8 changes: 4 additions & 4 deletions examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@



<link rel="canonical" href="https://beckett-software.github.io/clientele/examples/">
<link rel="canonical" href="https://phalt.github.io/clientele/examples/">


<link rel="prev" href="../compatibility/">
Expand All @@ -17,7 +17,7 @@
<link rel="next" href="../CHANGELOG/">

<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.19">
<meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">



Expand Down Expand Up @@ -461,10 +461,10 @@

<h1 id="client-example">🪄 Client example</h1>
<p>Let's build an API Client using clientele and an example OpenAPI schema.</p>
<p>Our <a href="https://github.com/beckett-software/clientele/tree/main/example_openapi_specs">GitHub</a> has a bunch of schemas that are proven to work with clientele, so let's use one of those!</p>
<p>Our <a href="https://github.com/phalt/clientele/tree/main/example_openapi_specs">GitHub</a> has a bunch of schemas that are proven to work with clientele, so let's use one of those!</p>
<h2 id="generate-the-client">Generate the client</h2>
<p>Very simply:</p>
<div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>clientele<span class="w"> </span>generate<span class="w"> </span>-u<span class="w"> </span>https://raw.githubusercontent.com/beckett-software/clientele/main/example_openapi_specs/simple.json<span class="w"> </span>-o<span class="w"> </span>my_client/
<div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>clientele<span class="w"> </span>generate<span class="w"> </span>-u<span class="w"> </span>https://raw.githubusercontent.com/phalt/clientele/main/example_openapi_specs/simple.json<span class="w"> </span>-o<span class="w"> </span>my_client/
</span></code></pre></div>
<p>The <code>-u</code> parameter expects a URL, you can provide a path to a file with <code>-f</code> instead if you download the file.</p>
<p>The <code>-o</code> parameter is the output directory of the generated client.</p>
Expand Down
6 changes: 3 additions & 3 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@



<link rel="canonical" href="https://beckett-software.github.io/clientele/">
<link rel="canonical" href="https://phalt.github.io/clientele/">



<link rel="next" href="install/">

<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.19">
<meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">



Expand Down Expand Up @@ -358,7 +358,7 @@
<p align="center">
<h1>⚜️ Clientele</h1>
<em>Typed API Clients from OpenAPI schemas</em>
<img src="https://github.com/beckett-software/clientele/blob/main/docs/clientele.jpeg?raw=true">
<img src="https://github.com/phalt/clientele/blob/main/docs/clientele.jpeg?raw=true">
</p>

<p align="center">
Expand Down
4 changes: 2 additions & 2 deletions install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@



<link rel="canonical" href="https://beckett-software.github.io/clientele/install/">
<link rel="canonical" href="https://phalt.github.io/clientele/install/">


<link rel="prev" href="..">
Expand All @@ -17,7 +17,7 @@
<link rel="next" href="../usage/">

<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.19">
<meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">



Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions sitemap.xml
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://beckett-software.github.io/clientele/</loc>
<lastmod>2023-07-30</lastmod>
<loc>https://phalt.github.io/clientele/</loc>
<lastmod>2023-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://beckett-software.github.io/clientele/CHANGELOG/</loc>
<lastmod>2023-07-30</lastmod>
<loc>https://phalt.github.io/clientele/CHANGELOG/</loc>
<lastmod>2023-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://beckett-software.github.io/clientele/compatibility/</loc>
<lastmod>2023-07-30</lastmod>
<loc>https://phalt.github.io/clientele/compatibility/</loc>
<lastmod>2023-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://beckett-software.github.io/clientele/examples/</loc>
<lastmod>2023-07-30</lastmod>
<loc>https://phalt.github.io/clientele/examples/</loc>
<lastmod>2023-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://beckett-software.github.io/clientele/install/</loc>
<lastmod>2023-07-30</lastmod>
<loc>https://phalt.github.io/clientele/install/</loc>
<lastmod>2023-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://beckett-software.github.io/clientele/usage/</loc>
<lastmod>2023-07-30</lastmod>
<loc>https://phalt.github.io/clientele/usage/</loc>
<lastmod>2023-07-31</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
Binary file not shown.
6 changes: 3 additions & 3 deletions usage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@



<link rel="canonical" href="https://beckett-software.github.io/clientele/usage/">
<link rel="canonical" href="https://phalt.github.io/clientele/usage/">


<link rel="prev" href="../install/">
Expand All @@ -17,7 +17,7 @@
<link rel="next" href="../compatibility/">

<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.19">
<meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">



Expand Down Expand Up @@ -423,7 +423,7 @@ <h1 id="usage">📝 Usage</h1>
<p>Clientele provides a single command, <code>generate</code>, for generating your API Clients.</p>
<h2 id="from-a-url">From a URL</h2>
<p>Assuming the OpenAPI schema is available on the internet somewhere, you can query it to generate your client.</p>
<div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>clientele<span class="w"> </span>generate<span class="w"> </span>-u<span class="w"> </span>https://raw.githubusercontent.com/beckett-software/clientele/main/example_openapi_specs/simple.json<span class="w"> </span>-o<span class="w"> </span>my_client/
<div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>clientele<span class="w"> </span>generate<span class="w"> </span>-u<span class="w"> </span>https://raw.githubusercontent.com/phalt/clientele/main/example_openapi_specs/simple.json<span class="w"> </span>-o<span class="w"> </span>my_client/
</span></code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
Expand Down

0 comments on commit a51bf1c

Please sign in to comment.