231 lines
13 KiB
HTML
231 lines
13 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Setting up the local environment and workspace — Common Python Library documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Tutorials" href="tutorials.html" />
|
||
<link rel="prev" title="Getting started with CPL" href="quickstart.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting started</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Getting started with CPL</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Setting up the local environment and workspace</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#install-the-package">Install the package</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#install-the-cli">Install the CLI</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#install-the-query">Install the query</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#create-initial-console-app">Create initial console app</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#create-initial-library">Create initial library</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#start-the-app">Start the app</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#what-s-next">What’s next</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Common Python Library</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||
<li><a href="getting_started.html">Getting started</a> »</li>
|
||
<li>Setting up the local environment and workspace</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/setup.md.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="setting-up-the-local-environment-and-workspace">
|
||
<h1>Setting up the local environment and workspace<a class="headerlink" href="#setting-up-the-local-environment-and-workspace" title="Permalink to this heading"></a></h1>
|
||
<section id="table-of-contents">
|
||
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading"></a></h2>
|
||
<ol class="arabic simple">
|
||
<li><p><span class="xref myst">Prerequisites</span></p></li>
|
||
<li><p><span class="xref myst">Install the package</span></p></li>
|
||
<li><p><span class="xref myst">Install the CLI</span></p></li>
|
||
<li><p><span class="xref myst">Install the query</span></p></li>
|
||
<li><p><span class="xref myst">Create a initial application</span></p></li>
|
||
<li><p><span class="xref myst">Create a initial library</span></p></li>
|
||
<li><p><span class="xref myst">Start the application</span></p></li>
|
||
<li><p><span class="xref myst">What’s next</span></p></li>
|
||
</ol>
|
||
</section>
|
||
<section id="prerequisites">
|
||
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this heading"></a></h2>
|
||
<p>To get most out of this tutorial you should already have a basic understanding of the following.</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://www.python.org/">Python</a></p></li>
|
||
</ul>
|
||
<p>Also you need to have the following installed.</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://www.python.org/">Python</a></p></li>
|
||
<li><p><a class="reference external" href="https://pip.sh-edraft.de">Pip</a></p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="install-the-package">
|
||
<h2>Install the package<a class="headerlink" href="#install-the-package" title="Permalink to this heading"></a></h2>
|
||
<p>To install the package, open a terminal window and run the following command:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>cpl-core<span class="w"> </span>--extra-index-url<span class="w"> </span>https://pip.sh-edraft.de
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="install-the-cli">
|
||
<h2>Install the CLI<a class="headerlink" href="#install-the-cli" title="Permalink to this heading"></a></h2>
|
||
<p>You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages.</p>
|
||
<p>To install the CLI, open a terminal window and run the following command:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>cpl-cli<span class="w"> </span>--extra-index-url<span class="w"> </span>https://pip.sh-edraft.de
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="install-the-query">
|
||
<h2>Install the query<a class="headerlink" href="#install-the-query" title="Permalink to this heading"></a></h2>
|
||
<p>To install the package, open a terminal window and run the following command:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>cpl-query<span class="w"> </span>--extra-index-url<span class="w"> </span>https://pip.sh-edraft.de
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="create-initial-console-app">
|
||
<h2>Create initial console app<a class="headerlink" href="#create-initial-console-app" title="Permalink to this heading"></a></h2>
|
||
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.</p>
|
||
<ol class="arabic">
|
||
<li><p>Run the CLI command <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span> <span class="pre">console</span></code> and provide the name my-app, as shown here:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl<span class="w"> </span>new<span class="w"> </span>console<span class="w"> </span>my-app
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>The cpl new command prompts you for information about features to include in the initial app. Decline the defaults by enter ‘n’ and press the Enter key.</p></li>
|
||
</ol>
|
||
<p>The CLI create a new workspace and a simple ‘Hello World’ app, ready to run.</p>
|
||
</section>
|
||
<section id="create-initial-library">
|
||
<h2>Create initial library<a class="headerlink" href="#create-initial-library" title="Permalink to this heading"></a></h2>
|
||
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.</p>
|
||
<ol class="arabic">
|
||
<li><p>Run the CLI command <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span> <span class="pre">library</span></code> and provide the name my-lib, as shown here:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl<span class="w"> </span>new<span class="w"> </span>library<span class="w"> </span>my-lib
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>The cpl new command prompts you for information about features to include in the initial library. Decline the defaults by enter ‘n’ and press the Enter key.</p></li>
|
||
</ol>
|
||
<p>The CLI create a new workspace and a simple ‘Hello World’ library with CLI, ready to run.</p>
|
||
</section>
|
||
<section id="start-the-app">
|
||
<h2>Start the app<a class="headerlink" href="#start-the-app" title="Permalink to this heading"></a></h2>
|
||
<p>The CLI includes a live development server, so that you can run your app locally.</p>
|
||
<ol class="arabic">
|
||
<li><p>Open a terminal window</p></li>
|
||
<li><p>To navigate to your project workspace, run the following command:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>/path/to/project/name
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>To run the app run:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl<span class="w"> </span>start
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">start</span></code> command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files.</p>
|
||
<p>If your installation and setup was successful, you should see a output similar to the following:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Hello<span class="w"> </span>World
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="what-s-next">
|
||
<h2>What’s next<a class="headerlink" href="#what-s-next" title="Permalink to this heading"></a></h2>
|
||
<ul class="simple">
|
||
<li><p>To learn more about the CPL CLI, see the <a class="reference internal" href="cpl_cli.overview.html"><span class="doc std std-doc">CLI Overview</span></a></p></li>
|
||
<li><p>Fore more informations about the Pyhton files generated by <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span></code>, see <a class="reference internal" href="cpl_cli.new.html"><span class="doc std std-doc">New Command</span></a></p></li>
|
||
</ul>
|
||
<!-- LINKS -->
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="quickstart.html" class="btn btn-neutral float-left" title="Getting started with CPL" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="tutorials.html" class="btn btn-neutral float-right" title="Tutorials" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |