evennia/docs/latest/api/evennia.contrib.utils.git_integration.git_integration.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

439 lines
No EOL
49 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>evennia.contrib.utils.git_integration.git_integration &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.contrib.utils.git_integration.tests" href="evennia.contrib.utils.git_integration.tests.html" />
<link rel="prev" title="evennia.contrib.utils.git_integration" href="evennia.contrib.utils.git_integration.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.git_integration.tests.html" title="evennia.contrib.utils.git_integration.tests"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.git_integration.html" title="evennia.contrib.utils.git_integration"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.git_integration.html" accesskey="U">evennia.contrib.utils.git_integration</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.git_integration.git_integration</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.utils.git_integration.git_integration">
<span id="evennia-contrib-utils-git-integration-git-integration"></span><h1>evennia.contrib.utils.git_integration.git_integration<a class="headerlink" href="#module-evennia.contrib.utils.git_integration.git_integration" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.utils.git_integration.git_integration.</span></span><span class="sig-name descname"><span class="pre">GitCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCommand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">MuxCommand</span></code></a></p>
<p>The shared functionality between git/git evennia</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.parse">
<span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCommand.parse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.parse" title="Link to this definition"></a></dt>
<dd><p>Parse the arguments, set default arg to status and check for existence of currently targeted repo</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.short_sha">
<span class="sig-name descname"><span class="pre">short_sha</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hexsha</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCommand.short_sha"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.short_sha" title="Link to this definition"></a></dt>
<dd><p>Utility: Get the short SHA of a commit.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.get_status">
<span class="sig-name descname"><span class="pre">get_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCommand.get_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.get_status" title="Link to this definition"></a></dt>
<dd><p>Retrieves the status of the active git repository, displaying unstaged changes/untracked files.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.get_branches">
<span class="sig-name descname"><span class="pre">get_branches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCommand.get_branches"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.get_branches" title="Link to this definition"></a></dt>
<dd><p>Display current and available branches.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.checkout">
<span class="sig-name descname"><span class="pre">checkout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCommand.checkout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.checkout" title="Link to this definition"></a></dt>
<dd><p>Check out a specific branch.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.pull">
<span class="sig-name descname"><span class="pre">pull</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCommand.pull"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.pull" title="Link to this definition"></a></dt>
<dd><p>Attempt to pull new code.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.func">
<span class="sig-name descname"><span class="pre">func</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCommand.func"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.func" title="Link to this definition"></a></dt>
<dd><p>Provide basic Git functionality within the game.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'general'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'command'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:all();'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCommand.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nThe</span> <span class="pre">shared</span> <span class="pre">functionality</span> <span class="pre">between</span> <span class="pre">git/git</span> <span class="pre">evennia\n'}</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.utils.git_integration.git_integration.</span></span><span class="sig-name descname"><span class="pre">CmdGitEvennia</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#CmdGitEvennia"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand" title="evennia.contrib.utils.git_integration.git_integration.GitCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">GitCommand</span></code></a></p>
<p>Pull the latest code from the evennia core or checkout a different branch.</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>git evennia status - View an overview of the evennia repository status.
git evennia branch - View available branches in evennia.
git evennia checkout &lt;branch&gt; - Checkout a different branch in evennia.
git evennia pull - Pull the latest evennia code.</p>
</dd>
</dl>
<p>For updating your local mygame repository, the same commands are available with git.</p>
<p>If there are any conflicts encountered, the command will abort. The command will reload your game after pulling new code automatically, but for some changes involving persistent scripts etc, you may need to manually restart.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'git</span> <span class="pre">evennia'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.locks">
<span class="sig-name descname"><span class="pre">locks</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:pperm(Developer)'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'system'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory">
<span class="sig-name descname"><span class="pre">directory</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/home/runner/work/evennia/evennia/evennia'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.repo_type">
<span class="sig-name descname"><span class="pre">repo_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Evennia'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.repo_type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.remote_link">
<span class="sig-name descname"><span class="pre">remote_link</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://github.com/evennia/evennia.git'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.remote_link" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:pperm(Developer)'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'git</span> <span class="pre">evennia',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nPull</span> <span class="pre">the</span> <span class="pre">latest</span> <span class="pre">code</span> <span class="pre">from</span> <span class="pre">the</span> <span class="pre">evennia</span> <span class="pre">core</span> <span class="pre">or</span> <span class="pre">checkout</span> <span class="pre">a</span> <span class="pre">different</span> <span class="pre">branch.\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">git</span> <span class="pre">evennia</span> <span class="pre">status</span> <span class="pre">-</span> <span class="pre">View</span> <span class="pre">an</span> <span class="pre">overview</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">evennia</span> <span class="pre">repository</span> <span class="pre">status.\n</span>&#160;&#160;&#160; <span class="pre">git</span> <span class="pre">evennia</span> <span class="pre">branch</span> <span class="pre">-</span> <span class="pre">View</span> <span class="pre">available</span> <span class="pre">branches</span> <span class="pre">in</span> <span class="pre">evennia.\n</span>&#160;&#160;&#160; <span class="pre">git</span> <span class="pre">evennia</span> <span class="pre">checkout</span> <span class="pre">&lt;branch&gt;</span> <span class="pre">-</span> <span class="pre">Checkout</span> <span class="pre">a</span> <span class="pre">different</span> <span class="pre">branch</span> <span class="pre">in</span> <span class="pre">evennia.\n</span>&#160;&#160;&#160; <span class="pre">git</span> <span class="pre">evennia</span> <span class="pre">pull</span> <span class="pre">-</span> <span class="pre">Pull</span> <span class="pre">the</span> <span class="pre">latest</span> <span class="pre">evennia</span> <span class="pre">code.\n\nFor</span> <span class="pre">updating</span> <span class="pre">your</span> <span class="pre">local</span> <span class="pre">mygame</span> <span class="pre">repository,</span> <span class="pre">the</span> <span class="pre">same</span> <span class="pre">commands</span> <span class="pre">are</span> <span class="pre">available</span> <span class="pre">with</span> <span class="pre">'git'.\n\nIf</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">any</span> <span class="pre">conflicts</span> <span class="pre">encountered,</span> <span class="pre">the</span> <span class="pre">command</span> <span class="pre">will</span> <span class="pre">abort.</span> <span class="pre">The</span> <span class="pre">command</span> <span class="pre">will</span> <span class="pre">reload</span> <span class="pre">your</span> <span class="pre">game</span> <span class="pre">after</span> <span class="pre">pulling</span> <span class="pre">new</span> <span class="pre">code</span> <span class="pre">automatically,</span> <span class="pre">but</span> <span class="pre">for</span> <span class="pre">some</span> <span class="pre">changes</span> <span class="pre">involving</span> <span class="pre">persistent</span> <span class="pre">scripts</span> <span class="pre">etc,</span> <span class="pre">you</span> <span class="pre">may</span> <span class="pre">need</span> <span class="pre">to</span> <span class="pre">manually</span> <span class="pre">restart.\n&quot;}</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.utils.git_integration.git_integration.</span></span><span class="sig-name descname"><span class="pre">CmdGit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#CmdGit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand" title="evennia.contrib.utils.git_integration.git_integration.GitCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">GitCommand</span></code></a></p>
<p>Pull the latest code from your repository or checkout a different branch.</p>
<dl class="simple">
<dt>Usage:</dt><dd><p>git status - View an overview of your git repository.
git branch - View available branches.
git checkout main - Checkout the main branch of your code.
git pull - Pull the latest code from your current branch.</p>
</dd>
</dl>
<p>For updating evennia code, the same commands are available with git evennia.</p>
<p>If there are any conflicts encountered, the command will abort. The command will reload your game after pulling new code automatically, but for changes involving persistent scripts etc, you may need to manually restart.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.key">
<span class="sig-name descname"><span class="pre">key</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'git'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.key" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.locks">
<span class="sig-name descname"><span class="pre">locks</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:pperm(Developer)'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.locks" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.help_category">
<span class="sig-name descname"><span class="pre">help_category</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'system'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.help_category" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.directory">
<span class="sig-name descname"><span class="pre">directory</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/home/runner/work/evennia/evennia/evennia/game_template'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.directory" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.repo_type">
<span class="sig-name descname"><span class="pre">repo_type</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'game'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.repo_type" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.remote_link">
<span class="sig-name descname"><span class="pre">remote_link</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'[your</span> <span class="pre">remote</span> <span class="pre">link]'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.remote_link" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[]</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.lock_storage">
<span class="sig-name descname"><span class="pre">lock_storage</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cmd:pperm(Developer)'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.lock_storage" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.CmdGit.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'',</span> <span class="pre">'category':</span> <span class="pre">'system',</span> <span class="pre">'key':</span> <span class="pre">'git',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nPull</span> <span class="pre">the</span> <span class="pre">latest</span> <span class="pre">code</span> <span class="pre">from</span> <span class="pre">your</span> <span class="pre">repository</span> <span class="pre">or</span> <span class="pre">checkout</span> <span class="pre">a</span> <span class="pre">different</span> <span class="pre">branch.\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">git</span> <span class="pre">status</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">View</span> <span class="pre">an</span> <span class="pre">overview</span> <span class="pre">of</span> <span class="pre">your</span> <span class="pre">git</span> <span class="pre">repository.\n</span>&#160;&#160;&#160; <span class="pre">git</span> <span class="pre">branch</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">View</span> <span class="pre">available</span> <span class="pre">branches.\n</span>&#160;&#160;&#160; <span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">main</span> <span class="pre">-</span> <span class="pre">Checkout</span> <span class="pre">the</span> <span class="pre">main</span> <span class="pre">branch</span> <span class="pre">of</span> <span class="pre">your</span> <span class="pre">code.\n</span>&#160;&#160;&#160; <span class="pre">git</span> <span class="pre">pull</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">Pull</span> <span class="pre">the</span> <span class="pre">latest</span> <span class="pre">code</span> <span class="pre">from</span> <span class="pre">your</span> <span class="pre">current</span> <span class="pre">branch.\n\nFor</span> <span class="pre">updating</span> <span class="pre">evennia</span> <span class="pre">code,</span> <span class="pre">the</span> <span class="pre">same</span> <span class="pre">commands</span> <span class="pre">are</span> <span class="pre">available</span> <span class="pre">with</span> <span class="pre">'git</span> <span class="pre">evennia'.\n\nIf</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">any</span> <span class="pre">conflicts</span> <span class="pre">encountered,</span> <span class="pre">the</span> <span class="pre">command</span> <span class="pre">will</span> <span class="pre">abort.</span> <span class="pre">The</span> <span class="pre">command</span> <span class="pre">will</span> <span class="pre">reload</span> <span class="pre">your</span> <span class="pre">game</span> <span class="pre">after</span> <span class="pre">pulling</span> <span class="pre">new</span> <span class="pre">code</span> <span class="pre">automatically,</span> <span class="pre">but</span> <span class="pre">for</span> <span class="pre">changes</span> <span class="pre">involving</span> <span class="pre">persistent</span> <span class="pre">scripts</span> <span class="pre">etc,</span> <span class="pre">you</span> <span class="pre">may</span> <span class="pre">need</span> <span class="pre">to</span> <span class="pre">manually</span> <span class="pre">restart.\n&quot;}</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCmdSet">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.contrib.utils.git_integration.git_integration.</span></span><span class="sig-name descname"><span class="pre">GitCmdSet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdsetobj</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCmdSet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCmdSet" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">CmdSet</span></code></a></p>
<p>The git command.</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCmdSet.at_cmdset_creation">
<span class="sig-name descname"><span class="pre">at_cmdset_creation</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/utils/git_integration/git_integration.html#GitCmdSet.at_cmdset_creation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCmdSet.at_cmdset_creation" title="Link to this definition"></a></dt>
<dd><p>Hook method - this should be overloaded in the inheriting
class, and should take care of populating the cmdset by use of
self.add().</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.utils.git_integration.git_integration.GitCmdSet.path">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'evennia.contrib.utils.git_integration.git_integration.GitCmdSet'</span></em><a class="headerlink" href="#evennia.contrib.utils.git_integration.git_integration.GitCmdSet.path" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</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/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<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>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib.utils.git_integration.git_integration</a><ul>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand"><code class="docutils literal notranslate"><span class="pre">GitCommand</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.parse"><code class="docutils literal notranslate"><span class="pre">GitCommand.parse()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.short_sha"><code class="docutils literal notranslate"><span class="pre">GitCommand.short_sha()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.get_status"><code class="docutils literal notranslate"><span class="pre">GitCommand.get_status()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.get_branches"><code class="docutils literal notranslate"><span class="pre">GitCommand.get_branches()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.checkout"><code class="docutils literal notranslate"><span class="pre">GitCommand.checkout()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.pull"><code class="docutils literal notranslate"><span class="pre">GitCommand.pull()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.func"><code class="docutils literal notranslate"><span class="pre">GitCommand.func()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.aliases"><code class="docutils literal notranslate"><span class="pre">GitCommand.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.help_category"><code class="docutils literal notranslate"><span class="pre">GitCommand.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.key"><code class="docutils literal notranslate"><span class="pre">GitCommand.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.lock_storage"><code class="docutils literal notranslate"><span class="pre">GitCommand.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCommand.search_index_entry"><code class="docutils literal notranslate"><span class="pre">GitCommand.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.key"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.locks"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.help_category"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.directory"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.directory</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.repo_type"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.repo_type</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.remote_link"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.remote_link</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.aliases"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGitEvennia.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdGitEvennia.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit"><code class="docutils literal notranslate"><span class="pre">CmdGit</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.key"><code class="docutils literal notranslate"><span class="pre">CmdGit.key</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.locks"><code class="docutils literal notranslate"><span class="pre">CmdGit.locks</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.help_category"><code class="docutils literal notranslate"><span class="pre">CmdGit.help_category</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.directory"><code class="docutils literal notranslate"><span class="pre">CmdGit.directory</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.repo_type"><code class="docutils literal notranslate"><span class="pre">CmdGit.repo_type</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.remote_link"><code class="docutils literal notranslate"><span class="pre">CmdGit.remote_link</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.aliases"><code class="docutils literal notranslate"><span class="pre">CmdGit.aliases</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.lock_storage"><code class="docutils literal notranslate"><span class="pre">CmdGit.lock_storage</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.CmdGit.search_index_entry"><code class="docutils literal notranslate"><span class="pre">CmdGit.search_index_entry</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCmdSet"><code class="docutils literal notranslate"><span class="pre">GitCmdSet</span></code></a><ul>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCmdSet.at_cmdset_creation"><code class="docutils literal notranslate"><span class="pre">GitCmdSet.at_cmdset_creation()</span></code></a></li>
<li><a class="reference internal" href="#evennia.contrib.utils.git_integration.git_integration.GitCmdSet.path"><code class="docutils literal notranslate"><span class="pre">GitCmdSet.path</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.contrib.utils.git_integration.html"
title="previous chapter">evennia.contrib.utils.git_integration</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.utils.git_integration.tests.html"
title="next chapter">evennia.contrib.utils.git_integration.tests</a></p>
</div>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.utils.git_integration.git_integration.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.git_integration.tests.html" title="evennia.contrib.utils.git_integration.tests"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.utils.git_integration.html" title="evennia.contrib.utils.git_integration"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.utils.html" >evennia.contrib.utils</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.utils.git_integration.html" >evennia.contrib.utils.git_integration</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.utils.git_integration.git_integration</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>