83 lines
2.9 KiB
HTML
83 lines
2.9 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Installation - pyserve</title>
|
|
<link rel="stylesheet" href="../style.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css">
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
|
|
<script>hljs.highlightAll();</script>
|
|
</head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="header">
|
|
<h1>pyserve</h1>
|
|
<div class="tagline">python application orchestrator</div>
|
|
</div>
|
|
|
|
<div class="breadcrumb">
|
|
<a href="../index.html">Home</a> / <a href="index.html">Getting Started</a> / Installation
|
|
</div>
|
|
|
|
<div id="content">
|
|
<h2>Installation</h2>
|
|
|
|
<h3>Requirements</h3>
|
|
<ul class="indent">
|
|
<li>Python 3.12 or higher</li>
|
|
<li>pip (Python package manager)</li>
|
|
</ul>
|
|
|
|
<h3>Install from Release (Recommended)</h3>
|
|
<p>Download the latest wheel file from <a href="https://git.pyserve.org/Shifty/pyserveX/releases">Git Releases</a> and install it:</p>
|
|
|
|
<pre><code class="language-bash"># Download the wheel file from releases
|
|
# Example: pyserve-0.7.0-py3-none-any.whl
|
|
|
|
pip install pyserve-0.7.0-py3-none-any.whl</code></pre>
|
|
|
|
<p>After installation, the <code>pyserve</code> command will be available in your terminal:</p>
|
|
<pre><code class="language-bash">pyserve --version</code></pre>
|
|
|
|
<h3>Install from Source</h3>
|
|
<p>For development or if you want the latest changes:</p>
|
|
|
|
<pre><code class="language-bash"># Clone the repository
|
|
git clone https://github.com/ShiftyX1/PyServe.git
|
|
cd PyServe
|
|
|
|
# Install with Poetry (recommended for development)
|
|
make init
|
|
|
|
# Or build and install the package
|
|
make build
|
|
pip install dist/pyserve-*.whl</code></pre>
|
|
|
|
<h3>Verify Installation</h3>
|
|
<p>Check that pyserve is installed correctly:</p>
|
|
<pre><code class="language-bash">pyserve --version
|
|
# Output: pyserve 0.7.0</code></pre>
|
|
|
|
<h3>Dependencies</h3>
|
|
<p>pyserve automatically installs the following dependencies:</p>
|
|
<ul class="indent">
|
|
<li><code>starlette</code> — ASGI framework</li>
|
|
<li><code>uvicorn</code> — ASGI server</li>
|
|
<li><code>pyyaml</code> — YAML configuration parsing</li>
|
|
<li><code>structlog</code> — Structured logging</li>
|
|
<li><code>httpx</code> — HTTP client for reverse proxy</li>
|
|
</ul>
|
|
|
|
<div class="note">
|
|
<strong>Next:</strong> Continue to <a href="quickstart.html">Quick Start</a> to run your first server.
|
|
</div>
|
|
</div>
|
|
|
|
<div id="footer">
|
|
<p>pyserve © 2024-2025 | MIT License</p>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|