Skip to content

Commit 5caacf0

Browse files
xvikxvik
committed
Publish 4.1.0 documentation
1 parent 5c4e07c commit 5caacf0

File tree

36 files changed

+142
-62
lines changed

36 files changed

+142
-62
lines changed

‎4.1.0/404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -671,7 +671,7 @@ <h1>404 - Not found</h1>
671671
<div class="md-copyright">
672672

673673
<div class="md-copyright__highlight">
674-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
674+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
675675
</div>
676676

677677

‎4.1.0/about/compatibility/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -742,7 +742,7 @@ <h1 id="gradle-compatibility">Gradle compatibility<a class="headerlink" href="#g
742742
<div class="md-copyright">
743743

744744
<div class="md-copyright__highlight">
745-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
745+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
746746
</div>
747747

748748

‎4.1.0/about/history/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1127,7 +1127,7 @@ <h3 id="100-2017-12-20"><a href="https://github.com/xvik/gradle-use-python-plugi
11271127
<div class="md-copyright">
11281128

11291129
<div class="md-copyright__highlight">
1130-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
1130+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
11311131
</div>
11321132

11331133

‎4.1.0/about/license/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -670,7 +670,7 @@
670670
<h1>License</h1>
671671

672672
<p>The MIT License (MIT)</p>
673-
<p>Copyright &copy; 2017-2024, Vyacheslav Rusakov</p>
673+
<p>Copyright &copy; 2017-2026, Vyacheslav Rusakov</p>
674674
<p>Permission is hereby granted, free of charge, to any person obtaining a copy
675675
of this software and associated documentation files (the "Software"), to deal
676676
in the Software without restriction, including without limitation the rights
@@ -721,7 +721,7 @@ <h1>License</h1>
721721
<div class="md-copyright">
722722

723723
<div class="md-copyright__highlight">
724-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
724+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
725725
</div>
726726

727727

‎4.1.0/getting-started/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1079,7 +1079,7 @@ <h3 id="non-default-python">Non-default python<a class="headerlink" href="#non-d
10791079
<div class="md-copyright">
10801080

10811081
<div class="md-copyright__highlight">
1082-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
1082+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
10831083
</div>
10841084

10851085

‎4.1.0/guide/ci/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -954,7 +954,7 @@ <h2 id="system-packages">System packages<a class="headerlink" href="#system-pack
954954
<div class="md-copyright">
955955

956956
<div class="md-copyright__highlight">
957-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
957+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
958958
</div>
959959

960960

‎4.1.0/guide/configuration/index.html‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1044,6 +1044,21 @@ <h2 id="reference">Reference<a class="headerlink" href="#reference" title="Perma
10441044
</code></pre></div>
10451045
<p>Note that in case of multi-module project envPath is set to '.gradle/python' inside the root project,
10461046
even if plugin is activated inside module (see <a href="../multimodule/">multi-module setup</a>).</p>
1047+
<div class="admonition hint">
1048+
<p class="admonition-title">Hint</p>
1049+
<p>Plugin use pip <a href="https://pip.pypa.io/en/stable/cli/pip_install/#options">cli options</a>
1050+
to apply configuration. All options are logged into gradle console. </p>
1051+
<p><code>indexUrl</code> and <code>extraIndexUrls</code> may contain repository passwords.
1052+
Plugin hides these passwords from console output on <strong>default logs level</strong>, but
1053+
if you enable <code>--info</code> logs, passwords will be visible (because gradle logs all command
1054+
line arguments on info level).</p>
1055+
<p>Pip also support configuration with environment variables and in case like this it might be used
1056+
to hide configuration from logs on info level:</p>
1057+
<div class="highlight"><pre><span></span><code><span class="n">python</span><span class="w"> </span><span class="p">{</span>
1058+
<span class="w"> </span><span class="n">environment</span><span class="p">(</span><span class="err">&#39;</span><span class="n">PIP_EXTRA_INDEX_URL</span><span class="err">&#39;</span><span class="p">,</span><span class="w"> </span><span class="err">&#39;</span><span class="n">http</span><span class="p">:</span><span class="c1">//user:pass@extra-url.com&#39;)</span>
1059+
<span class="p">}</span>
1060+
</code></pre></div>
1061+
</div>
10471062
<h3 id="pythontask">PythonTask<a class="headerlink" href="#pythontask" title="Permanent link">&para;</a></h3>
10481063
<p>PythonTask configuration:</p>
10491064
<table>
@@ -1273,7 +1288,7 @@ <h3 id="pipinstalltask">PipInstallTask<a class="headerlink" href="#pipinstalltas
12731288
<div class="md-copyright">
12741289

12751290
<div class="md-copyright__highlight">
1276-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
1291+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
12771292
</div>
12781293

12791294

‎4.1.0/guide/docker/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1401,7 +1401,7 @@ <h3 id="network-problem">Network problem<a class="headerlink" href="#network-pro
14011401
<div class="md-copyright">
14021402

14031403
<div class="md-copyright__highlight">
1404-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
1404+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
14051405
</div>
14061406

14071407

‎4.1.0/guide/modules/index.html‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1068,6 +1068,18 @@ <h2 id="custom-pip-repository">Custom pip repository<a class="headerlink" href="
10681068
flag for pip commands supporting it: install, download, list and wheel. By default, it only affects <code>pipInstall</code> and <code>pipList</code> tasks.
10691069
Applied for all <code>BasePipTask</code>, so if you have custom pip tasks, it would be affected too.</p>
10701070
<p>In case of ssl problems (stale or self-signed certificated), mark domains as trusted (see example below)</p>
1071+
<div class="admonition note">
1072+
<p class="admonition-title">Note</p>
1073+
<p>If authorization is used in repository url <code>indexUrl "http://user:pass@custom-url.com"</code>
1074+
password would be hidden in gradle logs. <br />
1075+
Be aware that when gradle <code>--info</code> logs enabled <strong>password would be shown</strong>
1076+
(because in this case gradle logs all command line arguments).</p>
1077+
<p>As an alternative, <a href="https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-i">PIP_INDEX_URL</a> environment variable could be used:
1078+
<div class="highlight"><pre><span></span><code><span class="n">python</span><span class="w"> </span><span class="p">{</span>
1079+
<span class="w"> </span><span class="n">environment</span><span class="p">(</span><span class="err">&#39;</span><span class="n">PIP_INDEX_URL</span><span class="err">&#39;</span><span class="p">,</span><span class="w"> </span><span class="err">&#39;</span><span class="n">http</span><span class="p">:</span><span class="c1">//user:pass@custom-url.com&#39;)</span>
1080+
<span class="p">}</span>
1081+
</code></pre></div></p>
1082+
</div>
10711083
<h2 id="extra-pip-repositories">Extra pip repositories<a class="headerlink" href="#extra-pip-repositories" title="Permanent link">&para;</a></h2>
10721084
<p>To add additional pip repositories (probably self-hosted):</p>
10731085
<div class="highlight"><pre><span></span><code><span class="n">python</span><span class="w"> </span><span class="o">{</span>
@@ -1082,6 +1094,19 @@ <h2 id="extra-pip-repositories">Extra pip repositories<a class="headerlink" href
10821094
<p>Extra urls will be applied as <a href="https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-extra-index-url">--extra-index-url</a>
10831095
flag for pip commands supporting it: install, download, list and wheel. By default, it only affects <code>pipInstall</code> and <code>pipList</code> tasks.
10841096
Applied for all <code>BasePipTask</code>, so if you have custom pip tasks, it would be affected too.</p>
1097+
<div class="admonition note">
1098+
<p class="admonition-title">Note</p>
1099+
<p>If authorization is used in repository url <code>indexUrl "http://user:pass@extra-url.com"</code>
1100+
password would be hidden in gradle logs.<br />
1101+
Be aware that when gradle <code>--info</code> logs enabled <strong>password would be shown</strong>
1102+
(because in this case gradle logs all command line arguments).</p>
1103+
<p>As an alternative, <a href="https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-extra-index-url">PIP_EXTRA_INDEX_URL</a> environment variable could be used:
1104+
<div class="highlight"><pre><span></span><code><span class="n">python</span><span class="w"> </span><span class="p">{</span>
1105+
<span class="w"> </span><span class="n">environment</span><span class="p">(</span><span class="err">&#39;</span><span class="n">PIP_EXTRA_INDEX_URL</span><span class="err">&#39;</span><span class="p">,</span><span class="w"> </span><span class="err">&#39;</span><span class="n">http</span><span class="p">:</span><span class="c1">//user:pass@extra-url.com&#39;)</span>
1106+
<span class="p">}</span>
1107+
</code></pre></div></p>
1108+
<p>Multiple urls could be separated with space.</p>
1109+
</div>
10851110
<p>In case of ssl problems (stale or self-signed certificated), mark domains as trusted:</p>
10861111
<div class="highlight"><pre><span></span><code><span class="n">python</span><span class="w"> </span><span class="o">{</span>
10871112
<span class="w"> </span><span class="n">trustedHosts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="s2">&quot;extra-url.com&quot;</span><span class="o">]</span>
@@ -1283,7 +1308,7 @@ <h2 id="cleanup-environment">Cleanup environment<a class="headerlink" href="#cle
12831308
<div class="md-copyright">
12841309

12851310
<div class="md-copyright__highlight">
1286-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
1311+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
12871312
</div>
12881313

12891314

‎4.1.0/guide/multimodule/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -945,7 +945,7 @@ <h2 id="problems-resolution">Problems resolution<a class="headerlink" href="#pro
945945
<div class="md-copyright">
946946

947947
<div class="md-copyright__highlight">
948-
Copyright &copy; 2017-2024 Vyacheslav Rusakov
948+
Copyright &copy; 2017-2026 Vyacheslav Rusakov
949949
</div>
950950

951951

0 commit comments

Comments
 (0)