psqlpy-python.github.io/contribute.html at gh-pages · psqlpy-python/psqlpy-python.github.io · GitHub

History

43 lines (40 loc) · 22.2 KB

Raw

<!doctype html>

<head>

<style>

:root {

--vp-c-bg: #fff;

}

[data-theme="dark"] {

--vp-c-bg: #1b1b1f;

}

html,

body {

background: var(--vp-c-bg);

}

</style>

const userMode = localStorage.getItem("vuepress-theme-hope-scheme");

const systemDarkMode =

window.matchMedia &&

window.matchMedia("(prefers-color-scheme: dark)").matches;

if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {

document.documentElement.setAttribute("data-theme", "dark");

}

</script>

</head>

<body>

<div id="app"><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><div class="theme-container external-link-icon has-toc" vp-container><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><a class="route-link vp-brand" href="/" aria-label="Take me home"><span class="vp-site-name">PSQLPy</span></a></div><div class="vp-navbar-center"></div><div class="vp-navbar-end"><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/psqlpy-python/psqlpy" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:block;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:none;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><button type="button" class="slimsearch-button" aria-label="Search"><svg xmlns="http://www.w3.org/2000/svg" class="icon search-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="search icon"><path d="M192 480a256 256 0 1 1 512 0 256 256 0 0 1-512 0m631.776 362.496-143.2-143.168A318.464 318.464 0 0 0 768 480c0-176.736-143.264-320-320-320S128 303.264 128 480s143.264 320 320 320a318.016 318.016 0 0 0 184.16-58.592l146.336 146.368c12.512 12.48 32.768 12.48 45.28 0 12.48-12.512 12.48-32.768 0-45.28"></path></svg><div class="slimsearch-placeholder">Search</div><div class="slimsearch-key-hints"><kbd class="slimsearch-key">Ctrl</kbd><kbd class="slimsearch-key">K</kbd></div></button><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar" vp-sidebar><ul class="vp-sidebar-links"><li><a class="route-link auto-link vp-sidebar-link" href="/" aria-label="PSQLPy documentation"><iconify-icon class="vp-icon" icon="home" sizing="both" width="1em" height="1em"></iconify-icon>PSQLPy documentation</a></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><span class="vp-sidebar-title">The PSQLPy</span><span class="vp-arrow end"></span></button></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><span class="vp-sidebar-title">Components Overview</span><span class="vp-arrow end"></span></button></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><span class="vp-sidebar-title">Usage</span><span class="vp-arrow end"></span></button></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><span class="vp-sidebar-title">Integrations</span><span class="vp-arrow end"></span></button></section></li><li><a class="route-link auto-link vp-sidebar-link" href="/external_connection_pools.html" aria-label="External connection pools">External connection pools</a></li><li><a class="route-link route-link-active auto-link vp-sidebar-link active" href="/contribute.html" aria-label="Contribution guide">Contribution guide</a></li><li><a class="route-link auto-link vp-sidebar-link" href="/benchmarks.html" aria-label="Benchmarks">Benchmarks</a></li><li><a class="route-link auto-link vp-sidebar-link" href="/faq.html" aria-label="FAQ">FAQ</a></li></ul></aside><main id="main-content" class="vp-page"><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1>Contribution guide</h1><div class="page-info"><span class="page-date-info" aria-label="Writing Date📅" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span data-allow-mismatch="text">6/28/26</span><meta property="datePublished" content="2026-06-28T18:25:20.000Z"></span></div><hr></div><div class="" vp-content><div id="markdown-content"><p>We love contributions. This guide is for all fellas who want to make psqlpy better together.</p><p>There are several rules for contributors:</p><ul><li>Please do not add malware.</li><li>Please make sure that your request solves the problem.</li></ul><p>If you struggle with something or feel frustrated, you either create an issue, create a <a href="https://github.com/psqlpy-python/psqlpy/discussions" target="_blank" rel="noopener noreferrer">discussions</a>. page or publish a draft PR and ask your question in the description.</p><p>We have lots of tests in CI. But since CI runs from first-time contributors should be approved, you better test locally. It just takes less time to prepare PR for merging.</p><h2 id="setting-up-environment" tabindex="-1"><a class="header-anchor" href="#setting-up-environment"><span>Setting up environment</span></a></h2><p>Since it's rust-first project you need to install rust on your computer. The best way to do it is check <a href="https://www.rust-lang.org/tools/install" target="_blank" rel="noopener noreferrer">official site</a>.</p><p>After you install rust, you must prepare you python environment. One of the best ways is follow <a href="https://www.maturin.rs/installation" target="_blank" rel="noopener noreferrer">maturin offical documentation</a> but below you can find all necessary commands.</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code class="language-bash"><span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">> python3 -m venv .venv</span></span>

<span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">> source .venv/bin/activate</span></span>

<span class="line"><span style="--shiki-light:#383A42;--shiki-dark:#ABB2BF;">> pip install -U pip maturin prek pytest pytest-anyio pydantic pgpq</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Then you need to build <code>PSQLPy</code> project.</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code class="language-bash"><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">maturin</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> develop</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>After this step project is built and installed in your python environment you created in previous step.</p><h2 id="linting-and-type-checking" tabindex="-1"><a class="header-anchor" href="#linting-and-type-checking"><span>Linting and type checking</span></a></h2><p>We have prek configured with all our settings. We highly recommend you to install it as a git hook using prek install command.</p><p>But even without installation, you can run all lints manually:</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code class="language-bash"><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">prek</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;"> run</span><span style="--shiki-light:#986801;--shiki-dark:#D19A66;"> -a</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h2 id="testing" tabindex="-1"><a class="header-anchor" href="#testing"><span>Testing</span></a></h2><p>You need to have <code>PostgreSQL</code> server somewhere to run <code>pytest</code>.</p><p>Default credentials for testing <code>PostgreSQL</code> and you can configure it with env:</p><ul><li>host: <code>localhost</code> (env: POSTGRES_HOST)</li><li>user: <code>postgres</code> (env: POSTGRES_USER)</li><li>password: <code>postgres</code> (env: POSTGRES_PASSWORD)</li><li>port: <code>5432</code> (env: POSTGRES_PORT)</li><li>dbname: <code>psqlpy_test</code> (env: POSTGRES_DBNAME)</li></ul><p>We have tests with required SSL mode, so, if you don't want to run PostgreSQL in SSL mode, you could run</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code class="language-bash"><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">pytest</span><span style="--shiki-light:#986801;--shiki-dark:#D19A66;"> --ignore=</span><span style="--shiki-light:#50A14F;--shiki-dark:#98C379;">"./python/tests/test_ssl_mode.py"</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>If you have PostgreSQL with enabled ssl mode, you need to set path to your <code>ca_file</code> in <code>POSTGRES_CERT_FILE</code> env. And run</p><div class="language-bash line-numbers-mode" data-highlighter="shiki" data-ext="bash" style="--shiki-light:#383A42;--shiki-dark:#abb2bf;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#282c34;"><pre class="shiki shiki-themes one-light one-dark-pro vp-code"><code class="language-bash"><span class="line"><span style="--shiki-light:#4078F2;--shiki-dark:#61AFEF;">pytest</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></div></div><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/psqlpy-python/psqlpy/edit/main/contribute.md" aria-label="Edit this page" rel="noopener noreferrer" target="_blank"><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg>Edit this page</a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last Updated</span><time class="vp-meta-info" datetime="2026-06-28T18:25:20.000Z" data-allow-mismatch>6/28/26, 6:25 PM</time></div><div class="contributors"><span class="vp-meta-label">Contributors: </span><span class="vp-meta-info" title="email: chandr@chandr.net">chandr-andr (Kiselev Aleksandr)</span></div></div></footer><nav class="vp-page-nav"><a class="route-link auto-link prev" href="/external_connection_pools.html" aria-label="External connection pools"><div class="hint"><span class="arrow start"></span>Prev</div><div class="link">External connection pools</div></a><a class="route-link auto-link next" href="/benchmarks.html" aria-label="Benchmarks"><div class="hint">Next<span class="arrow end"></span></div><div class="link">Benchmarks</div></a></nav></main></div></div>

</body>

</html>

psqlpy-python.github.io/contribute.html at gh-pages · psqlpy-python/psqlpy-python.github.io · GitHub

Uh oh!

Expand file tree

Breadcrumbs

contribute.html

Latest commit

History

Breadcrumbs

contribute.html

File metadata and controls