Skip to content

Commit f5c849a

Browse files
github-actions[bot]github-actions[bot]
committed
Deployed 4de4043 to dev with MkDocs 1.6.0 and mike 2.1.1
1 parent 79f50f4 commit f5c849a

File tree

4 files changed

+92
-11
lines changed

4 files changed

+92
-11
lines changed

‎dev/404.html‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
<!--=========================================================================-->
2+
<!-- Copyright (c) 2024 Federico Busetti -->
3+
<!-- <[email protected]> -->
4+
<!-- -->
5+
<!-- Permission is hereby granted, free of charge, to any person obtaining a -->
6+
<!-- copy of this software and associated documentation files (the "Software"), -->
7+
<!-- to deal in the Software without restriction, including without limitation -->
8+
<!-- the rights to use, copy, modify, merge, publish, distribute, sublicense, -->
9+
<!-- and/or sell copies of the Software, and to permit persons to whom the -->
10+
<!-- Software is furnished to do so, subject to the following conditions: -->
11+
<!-- -->
12+
<!-- The above copyright notice and this permission notice shall be included in -->
13+
<!-- all copies or substantial portions of the Software. -->
14+
<!-- -->
15+
<!-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -->
16+
<!-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -->
17+
<!-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -->
18+
<!-- THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -->
19+
<!-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -->
20+
<!-- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -->
21+
<!-- DEALINGS IN THE SOFTWARE. -->
22+
<!--=========================================================================-->
23+
124

225
<!doctype html>
326
<html lang="en" class="no-js">

‎dev/API-Reference/index.html‎

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
<!--=========================================================================-->
2+
<!-- Copyright (c) 2024 Federico Busetti -->
3+
<!-- <[email protected]> -->
4+
<!-- -->
5+
<!-- Permission is hereby granted, free of charge, to any person obtaining a -->
6+
<!-- copy of this software and associated documentation files (the "Software"), -->
7+
<!-- to deal in the Software without restriction, including without limitation -->
8+
<!-- the rights to use, copy, modify, merge, publish, distribute, sublicense, -->
9+
<!-- and/or sell copies of the Software, and to permit persons to whom the -->
10+
<!-- Software is furnished to do so, subject to the following conditions: -->
11+
<!-- -->
12+
<!-- The above copyright notice and this permission notice shall be included in -->
13+
<!-- all copies or substantial portions of the Software. -->
14+
<!-- -->
15+
<!-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -->
16+
<!-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -->
17+
<!-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -->
18+
<!-- THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -->
19+
<!-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -->
20+
<!-- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -->
21+
<!-- DEALINGS IN THE SOFTWARE. -->
22+
<!--=========================================================================-->
23+
124

225
<!doctype html>
326
<html lang="en" class="no-js">
@@ -536,14 +559,14 @@ <h2 id="bootstrap_python_package.some_function" class="doc doc-heading">
536559

537560
<details class="quote">
538561
<summary>Source code in <code>bootstrap_python_package/__init__.py</code></summary>
539-
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
540-
<span class="normal">2</span>
541-
<span class="normal">3</span>
542-
<span class="normal">4</span>
543-
<span class="normal">5</span>
544-
<span class="normal">6</span>
545-
<span class="normal">7</span>
546-
<span class="normal">8</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">some_function</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
562+
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">28</span>
563+
<span class="normal">29</span>
564+
<span class="normal">30</span>
565+
<span class="normal">31</span>
566+
<span class="normal">32</span>
567+
<span class="normal">33</span>
568+
<span class="normal">34</span>
569+
<span class="normal">35</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">some_function</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
547570
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
548571
<span class="sd"> Some function docstring</span>
549572

‎dev/index.html‎

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
<!--=========================================================================-->
2+
<!-- Copyright (c) 2024 Federico Busetti -->
3+
<!-- <[email protected]> -->
4+
<!-- -->
5+
<!-- Permission is hereby granted, free of charge, to any person obtaining a -->
6+
<!-- copy of this software and associated documentation files (the "Software"), -->
7+
<!-- to deal in the Software without restriction, including without limitation -->
8+
<!-- the rights to use, copy, modify, merge, publish, distribute, sublicense, -->
9+
<!-- and/or sell copies of the Software, and to permit persons to whom the -->
10+
<!-- Software is furnished to do so, subject to the following conditions: -->
11+
<!-- -->
12+
<!-- The above copyright notice and this permission notice shall be included in -->
13+
<!-- all copies or substantial portions of the Software. -->
14+
<!-- -->
15+
<!-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -->
16+
<!-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -->
17+
<!-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -->
18+
<!-- THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -->
19+
<!-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -->
20+
<!-- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -->
21+
<!-- DEALINGS IN THE SOFTWARE. -->
22+
<!--=========================================================================-->
23+
124

225
<!doctype html>
326
<html lang="en" class="no-js">
@@ -498,10 +521,20 @@
498521

499522

500523
<h1 id="bootstrap-python-package">bootstrap-python-package</h1>
524+
<p><img alt="Static Badge" src="https://img.shields.io/badge/Python-3.8_%7C_3.9_%7C_3.10_%7C_3.11_%7C_3.12-blue?logo=python&amp;logoColor=white" />
525+
<a href="https://pypi.org/project/bootstrap-python-package/"><img alt="Stable Version" src="https://img.shields.io/pypi/v/bootstrap-python-package?color=blue" /></a>
526+
<a href="https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta"><img alt="stability-beta" src="https://img.shields.io/badge/stability-beta-33bbff.svg" /></a></p>
527+
<p><a href="https://github.com/febus982/bootstrap-python-package/actions/workflows/python-tests.yml"><img alt="Python tests" src="https://github.com/febus982/bootstrap-python-package/actions/workflows/python-tests.yml/badge.svg?branch=main" /></a>
528+
<a href="https://codeclimate.com/github/febus982/bootstrap-python-package/maintainability"><img alt="Maintainability" src="https://api.codeclimate.com/v1/badges/593e78ec96ed5ebb0dd3/maintainability" /></a>
529+
<a href="https://codeclimate.com/github/febus982/bootstrap-python-package/test_coverage"><img alt="Test Coverage" src="https://api.codeclimate.com/v1/badges/593e78ec96ed5ebb0dd3/test_coverage" /></a></p>
530+
<p><a href="https://mypy-lang.org/"><img alt="Checked with mypy" src="https://www.mypy-lang.org/static/mypy_badge.svg" /></a>
531+
<a href="https://github.com/charliermarsh/ruff"><img alt="Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json" /></a>
532+
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a>
533+
<a href="https://github.com/PyCQA/bandit"><img alt="security: bandit" src="https://img.shields.io/badge/security-bandit-yellow.svg" /></a></p>
501534
<p>This template repository provides the boilerplate to create a python package.
502535
It is configured with all the following features:</p>
503536
<ul>
504-
<li>Test suite using <a href="https://docs.pytest.org/en/7.4.x/">pytest</a></li>
537+
<li>Test suite using <a href="https://tox.wiki/en/latest/index.html">tox</a> and <a href="https://docs.pytest.org/en/7.4.x/">pytest</a></li>
505538
<li>Typing using <a href="https://mypy.readthedocs.io/en/stable/">mypy</a></li>
506539
<li>Linting, security and code format using <a href="https://github.com/astral-sh/ruff">ruff</a> (using <a href="https://pypi.org/project/black/">black</a>
507540
code style and <a href="https://github.com/PyCQA/bandit">bandit</a> security rules)</li>
@@ -512,14 +545,15 @@ <h1 id="bootstrap-python-package">bootstrap-python-package</h1>
512545
<li>GitHub pages documentation using <a href="https://www.mkdocs.org">mkdocs</a></li>
513546
</ul>
514547
</li>
548+
<li>PyCharm profile basic configuration</li>
515549
</ul>
516550
<h2 id="how-to-use-this-repository-template-to-create-a-new-package">How to use this repository template to create a new package</h2>
517551
<ul>
518552
<li>Create your github repository using this template. (The big green <code>Use this template</code> button)</li>
519553
<li>Rename the <code>bootstrap_python_package</code> directory</li>
520554
<li>Search and replace all the occurrences of <code>bootstrap-python-package</code> and <code>bootstrap_python_package</code></li>
521555
<li>Configure a pending trusted publisher on <a href="https://pypi.org/manage/account/publishing">pypi</a> using the following values:<ul>
522-
<li>PyPI Project Name: what you renamed the directory <code>bootstrap_python_package</code> to (Double check <code>_</code> and <code>-</code>)</li>
556+
<li>PyPI Project Name: The github repository name (in this case <code>bootstrap-python-package</code>)</li>
523557
<li>Owner: The github repository owner (in this case <code>febus982</code>)</li>
524558
<li>Repository name: The github repository name (in this case <code>bootstrap-python-package</code>)</li>
525559
<li>Workflow name: <code>release.yml</code></li>
@@ -529,6 +563,7 @@ <h2 id="how-to-use-this-repository-template-to-create-a-new-package">How to use
529563
containing the codeclimate reporter id (you can find it at <code>https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter</code>).
530564
If you don't want to use CodeClimate just delete <code>workflows/python-quality.yml</code>.</li>
531565
<li>Update the badges in <code>README.md</code>! (check <a href="https://shields.io/">shields.io</a> for extra badges)</li>
566+
<li>Update the PyCharm Copyright profile in the IDE settings: Editor | Copyright | Copyright Profiles (if you want to use it)</li>
532567
<li>Setup local development:<ul>
533568
<li>Clone the repository</li>
534569
<li>Install poetry <code>pip install poetry</code></li>

0 commit comments

Comments
 (0)