mirror of
https://github.com/kennethreitz/responder.git
synced 2026-06-05 23:00:17 +00:00
kennethreitz
241 lines
14 KiB
HTML
241 lines
14 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>Responder CLI — responder 3.2.0 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
|
||
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
|
||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
|
||
<link rel="stylesheet" type="text/css" href="_static/design-elements.e5416f61bae5d36adc6d722a2b6f8cff.css?v=452a8e97" />
|
||
<script src="_static/documentation_options.js?v=4f6ddb47"></script>
|
||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
|
||
<script src="_static/copybutton.js?v=fd10adb8"></script>
|
||
<script>
|
||
</script>
|
||
<script src="_static/design-elements.bbdccc18c4abea9397628f9fea3d48c2.js?v=03c7770e"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Changelog" href="changes.html" />
|
||
<link rel="prev" title="API Documentation" href="api.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<section id="responder-cli">
|
||
<h1>Responder CLI<a class="headerlink" href="#responder-cli" title="Link to this heading">¶</a></h1>
|
||
<p>Responder installs a command line program <code class="docutils literal notranslate"><span class="pre">responder</span></code>. Use it to launch
|
||
a Responder application from a file or module, either located on a local
|
||
or remote filesystem, or object store.</p>
|
||
<section id="launch-module-entrypoint">
|
||
<h2>Launch Module Entrypoint<a class="headerlink" href="#launch-module-entrypoint" title="Link to this heading">¶</a></h2>
|
||
<p>For loading a Responder application from a Python module, you will refer to
|
||
its <code class="docutils literal notranslate"><span class="pre">API()</span></code> instance using a <a class="reference external" href="https://packaging.python.org/en/latest/specifications/entry-points/">Python entry point object reference</a> that
|
||
points to a Python object. It is either in the form <code class="docutils literal notranslate"><span class="pre">importable.module</span></code>,
|
||
or <code class="docutils literal notranslate"><span class="pre">importable.module:object.attr</span></code>.</p>
|
||
<p>A basic invocation command to launch a Responder application:</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>responder<span class="w"> </span>run<span class="w"> </span>acme.app
|
||
</pre></div>
|
||
</div>
|
||
<p>The command above assumes a Python package <code class="docutils literal notranslate"><span class="pre">acme</span></code> including an <code class="docutils literal notranslate"><span class="pre">app</span></code>
|
||
module <code class="docutils literal notranslate"><span class="pre">acme/app.py</span></code> that includes an attribute <code class="docutils literal notranslate"><span class="pre">api</span></code> that refers
|
||
to a <code class="docutils literal notranslate"><span class="pre">responder.API</span></code> instance, reflecting the typical layout of
|
||
a standard Responder application.</p>
|
||
<p>Loading a Responder application using an entrypoint specification will
|
||
inherit the capacities of <a class="reference external" href="https://docs.python.org/3/reference/import.html">Python’s import system</a>, as implemented by
|
||
<a class="reference external" href="https://docs.python.org/3/library/importlib.html">importlib</a>.</p>
|
||
</section>
|
||
<section id="launch-local-file">
|
||
<h2>Launch Local File<a class="headerlink" href="#launch-local-file" title="Link to this heading">¶</a></h2>
|
||
<p>Acquire a minimal example single-file application, <code class="docutils literal notranslate"><span class="pre">helloworld.py</span></code> <a class="footnote-reference brackets" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>,
|
||
to your local filesystem, giving you the chance to edit it, and launch the
|
||
Responder HTTP service.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>wget<span class="w"> </span>https://github.com/kennethreitz/responder/raw/refs/heads/main/examples/helloworld.py
|
||
responder<span class="w"> </span>run<span class="w"> </span>helloworld.py
|
||
</pre></div>
|
||
</div>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>To validate the example application, invoke a HTTP request, for example using
|
||
<a class="reference external" href="https://curl.se/">curl</a>, <a class="reference external" href="https://httpie.io/docs/cli">HTTPie</a>, or your favourite browser at hand.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>http<span class="w"> </span>http://127.0.0.1:5042/Hello
|
||
</pre></div>
|
||
</div>
|
||
<p>The response is no surprise.</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>HTTP/1.1 200 OK
|
||
content-length: 13
|
||
content-type: text/plain
|
||
date: Sat, 26 Oct 2024 13:16:55 GMT
|
||
encoding: utf-8
|
||
server: uvicorn
|
||
|
||
Hello, world!
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<aside class="footnote-list brackets">
|
||
<aside class="footnote brackets" id="id2" role="doc-footnote">
|
||
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>
|
||
<p>The Responder application <a class="reference external" href="https://github.com/kennethreitz/responder/blob/main/examples/helloworld.py">helloworld.py</a> implements a basic echo handler.</p>
|
||
</aside>
|
||
</aside>
|
||
</section>
|
||
<section id="launch-remote-file">
|
||
<h2>Launch Remote File<a class="headerlink" href="#launch-remote-file" title="Link to this heading">¶</a></h2>
|
||
<p>You can also launch a single-file application where its Python file is stored
|
||
on a remote location.</p>
|
||
<p>Responder supports all filesystem adapters compatible with <a class="reference external" href="https://filesystem-spec.readthedocs.io/en/latest/">fsspec</a>, and
|
||
installs the adapters for Azure Blob Storage (az), Google Cloud Storage (gs),
|
||
GitHub, HTTP, and AWS S3 by default.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Works 1:1.</span>
|
||
responder<span class="w"> </span>run<span class="w"> </span>https://github.com/kennethreitz/responder/raw/refs/heads/main/examples/helloworld.py
|
||
responder<span class="w"> </span>run<span class="w"> </span>github://kennethreitz:responder@/examples/helloworld.py
|
||
</pre></div>
|
||
</div>
|
||
<p>If you need access other kinds of remote targets, see the <a class="reference external" href="https://github.com/fsspec/universal_pathlib#currently-supported-filesystems-and-protocols">list of
|
||
fsspec-supported filesystems and protocols</a>. The next section enumerates
|
||
a few synthetic examples. The corresponding storage buckets do not even
|
||
exist, so don’t expect those commands to work.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Azure Blob Storage, Google Cloud Storage, and AWS S3.</span>
|
||
responder<span class="w"> </span>run<span class="w"> </span>az://kennethreitz-assets/responder/examples/helloworld.py
|
||
responder<span class="w"> </span>run<span class="w"> </span>gs://kennethreitz-assets/responder/examples/helloworld.py
|
||
responder<span class="w"> </span>run<span class="w"> </span>s3://kennethreitz-assets/responder/examples/helloworld.py
|
||
|
||
<span class="c1"># Hadoop Distributed File System (hdfs), SSH File Transfer Protocol (sftp),</span>
|
||
<span class="c1"># Common Internet File System (smb), Web-based Distributed Authoring and</span>
|
||
<span class="c1"># Versioning (webdav).</span>
|
||
responder<span class="w"> </span>run<span class="w"> </span>hdfs://kennethreitz-assets/responder/examples/helloworld.py
|
||
responder<span class="w"> </span>run<span class="w"> </span>sftp://user@host/kennethreitz/responder/examples/helloworld.py
|
||
responder<span class="w"> </span>run<span class="w"> </span>smb://workgroup<span class="p">;</span>user:password@server:port/responder/examples/helloworld.py
|
||
responder<span class="w"> </span>run<span class="w"> </span>webdav+https://user:password@server:port/responder/examples/helloworld.py
|
||
</pre></div>
|
||
</div>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>In order to install support for all filesystem types supported by fsspec, run:</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>uv<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span><span class="s1">'fsspec[full]'</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>When using <code class="docutils literal notranslate"><span class="pre">uv</span></code>, this concludes within an acceptable time of approx.
|
||
25 seconds. If you need to be more selectively instead of using <code class="docutils literal notranslate"><span class="pre">full</span></code>,
|
||
choose from one or multiple of the available <a class="reference external" href="https://github.com/fsspec/filesystem_spec/blob/2024.12.0/pyproject.toml#L27-L69">fsspec extras</a>, which are:</p>
|
||
<p>abfs, arrow, dask, dropbox, fuse, gcs, git, github, hdfs, http, oci, s3,
|
||
sftp, smb, ssh.</p>
|
||
</div>
|
||
</section>
|
||
<section id="launch-with-non-standard-instance-name">
|
||
<h2>Launch with Non-Standard Instance Name<a class="headerlink" href="#launch-with-non-standard-instance-name" title="Link to this heading">¶</a></h2>
|
||
<p>By default, Responder will acquire an <code class="docutils literal notranslate"><span class="pre">responder.API</span></code> instance using the
|
||
symbol name <code class="docutils literal notranslate"><span class="pre">api</span></code> from the specified Python module.</p>
|
||
<p>If your main application file uses a different name than <code class="docutils literal notranslate"><span class="pre">api</span></code>, please
|
||
append the designated symbol name to the launch target address.</p>
|
||
<p>It works like this for module entrypoints and local files:</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>responder<span class="w"> </span>run<span class="w"> </span>acme.app:service
|
||
responder<span class="w"> </span>run<span class="w"> </span>/path/to/acme/app.py:service
|
||
</pre></div>
|
||
</div>
|
||
<p>It works like this for URLs:</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>responder<span class="w"> </span>run<span class="w"> </span>http://app.server.local/path/to/acme/app.py#service
|
||
</pre></div>
|
||
</div>
|
||
<p>Within your <code class="docutils literal notranslate"><span class="pre">app.py</span></code>, the instance would have been defined to use
|
||
the <code class="docutils literal notranslate"><span class="pre">service</span></code> symbol name instead of <code class="docutils literal notranslate"><span class="pre">api</span></code>, like this:</p>
|
||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">service</span> <span class="o">=</span> <span class="n">responder</span><span class="o">.</span><span class="n">API</span><span class="p">()</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="build-javascript-application">
|
||
<h2>Build JavaScript Application<a class="headerlink" href="#build-javascript-application" title="Link to this heading">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">build</span></code> subcommand invokes <code class="docutils literal notranslate"><span class="pre">npm</span> <span class="pre">run</span> <span class="pre">build</span></code>, optionally accepting
|
||
a target directory. By default, it uses the current working directory,
|
||
where it expects a regular NPM <code class="docutils literal notranslate"><span class="pre">package.json</span></code> file.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>responder<span class="w"> </span>build
|
||
</pre></div>
|
||
</div>
|
||
<p>When specifying a target directory, Responder will change to that
|
||
directory beforehand.</p>
|
||
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>responder<span class="w"> </span>build<span class="w"> </span>/path/to/project
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper"><p class="logo">
|
||
<a href="index.html">
|
||
<img class="logo" src="_static/responder.png" />
|
||
</a>
|
||
</p>
|
||
<p>
|
||
<strong>Responder</strong> — a familiar HTTP service framework for Python.
|
||
</p>
|
||
<h3>Useful Links</h3>
|
||
<ul>
|
||
<li><a href="https://github.com/kennethreitz/responder">Responder @ GitHub</a></li>
|
||
<li><a href="https://pypi.org/project/responder/">Responder @ PyPI</a></li>
|
||
<li><a href="https://github.com/kennethreitz/responder/issues">Issue Tracker</a></li>
|
||
</ul>
|
||
<div>
|
||
<h3><a href="index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Responder CLI</a><ul>
|
||
<li><a class="reference internal" href="#launch-module-entrypoint">Launch Module Entrypoint</a></li>
|
||
<li><a class="reference internal" href="#launch-local-file">Launch Local File</a></li>
|
||
<li><a class="reference internal" href="#launch-remote-file">Launch Remote File</a></li>
|
||
<li><a class="reference internal" href="#launch-with-non-standard-instance-name">Launch with Non-Standard Instance Name</a></li>
|
||
<li><a class="reference internal" href="#build-javascript-application">Build JavaScript Application</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2018-2026, Kenneth Reitz.
|
||
|
||
|
|
||
<a href="_sources/cli.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |