Esteban Maya
8 months ago
committed by
GitHub
GitHub
194 changed files with 3075 additions and 4166 deletions
@ -0,0 +1,34 @@ |
|||
docs: |
|||
- all: |
|||
- changed-files: |
|||
- any-glob-to-any-file: |
|||
- docs/en/docs/** |
|||
- docs_src/** |
|||
- all-globs-to-all-files: |
|||
- '!fastapi/**' |
|||
- '!pyproject.toml' |
|||
|
|||
lang-all: |
|||
- all: |
|||
- changed-files: |
|||
- any-glob-to-any-file: |
|||
- docs/*/docs/** |
|||
- all-globs-to-all-files: |
|||
- '!docs/en/docs/**' |
|||
- '!fastapi/**' |
|||
- '!pyproject.toml' |
|||
|
|||
internal: |
|||
- all: |
|||
- changed-files: |
|||
- any-glob-to-any-file: |
|||
- .github/** |
|||
- scripts/** |
|||
- .gitignore |
|||
- .pre-commit-config.yaml |
|||
- pdm_build.py |
|||
- requirements*.txt |
|||
- all-globs-to-all-files: |
|||
- '!docs/*/docs/**' |
|||
- '!fastapi/**' |
|||
- '!pyproject.toml' |
|||
@ -0,0 +1,18 @@ |
|||
name: Add to Project |
|||
|
|||
on: |
|||
pull_request_target: |
|||
issues: |
|||
types: |
|||
- opened |
|||
- reopened |
|||
|
|||
jobs: |
|||
add-to-project: |
|||
name: Add to project |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- uses: actions/[email protected] |
|||
with: |
|||
project-url: https://github.com/orgs/fastapi/projects/2 |
|||
github-token: ${{ secrets.PROJECTS_TOKEN }} |
|||
@ -0,0 +1,31 @@ |
|||
name: Labels |
|||
on: |
|||
pull_request_target: |
|||
types: |
|||
- opened |
|||
- synchronize |
|||
- reopened |
|||
# For label-checker |
|||
- labeled |
|||
- unlabeled |
|||
|
|||
jobs: |
|||
labeler: |
|||
permissions: |
|||
contents: read |
|||
pull-requests: write |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- uses: actions/labeler@v5 |
|||
# Run this after labeler applied labels |
|||
check-labels: |
|||
needs: |
|||
- labeler |
|||
permissions: |
|||
pull-requests: read |
|||
runs-on: ubuntu-latest |
|||
steps: |
|||
- uses: docker://agilepathway/pull-request-label-checker:latest |
|||
with: |
|||
one_of: breaking,security,feature,bug,refactor,upgrade,docs,lang-all,internal |
|||
repo_token: ${{ secrets.GITHUB_TOKEN }} |
|||
@ -1,185 +0,0 @@ |
|||
--- |
|||
hide: |
|||
- navigation |
|||
--- |
|||
|
|||
# FastAPI İnsanlar |
|||
|
|||
FastAPI-ın bütün mənşəli insanları qəbul edən heyrətamiz icması var. |
|||
|
|||
|
|||
|
|||
## Yaradıcı - İcraçı |
|||
|
|||
Salam! 👋 |
|||
|
|||
Bu mənəm: |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.maintainers %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Cavablar: {{ user.answers }}</div><div class="count">Pull Request-lər: {{ user.prs }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
Mən **FastAPI**-ın yaradıcısı və icraçısıyam. Əlavə məlumat almaq üçün [Yardım FastAPI - Yardım alın - Müəlliflə əlaqə qurun](help-fastapi.md#connect-with-the-author){.internal-link target=_blank} səhifəsinə baxa bilərsiniz. |
|||
|
|||
...Burada isə sizə icmanı göstərmək istəyirəm. |
|||
|
|||
--- |
|||
|
|||
**FastAPI** icmadan çoxlu dəstək alır və mən onların əməyini vurğulamaq istəyirəm. |
|||
|
|||
Bu insanlar: |
|||
|
|||
* [GitHub-da başqalarının suallarına kömək edirlər](help-fastapi.md#help-others-with-questions-in-github){.internal-link target=_blank}. |
|||
* [Pull Request-lər yaradırlar](help-fastapi.md#create-a-pull-request){.internal-link target=_blank}. |
|||
* Pull Request-ləri ([xüsusilə tərcümələr üçün vacib olan](contributing.md#translations){.internal-link target=_blank}.) nəzərdən keçirirlər. |
|||
|
|||
Bu insanlara təşəkkür edirəm. 👏 🙇 |
|||
|
|||
## Keçən ayın ən fəal istifadəçiləri |
|||
|
|||
Bu istifadəçilər keçən ay [GitHub-da başqalarının suallarına](help-fastapi.md#help-others-with-questions-in-github){.internal-link target=_blank} ən çox kömək edənlərdir. ☕ |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.last_month_experts[:10] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Cavablandırılmış suallar: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## Mütəxəssislər |
|||
|
|||
Burada **FastAPI Mütəxəssisləri** var. 🤓 |
|||
|
|||
Bu istifadəçilər indiyə qədər [GitHub-da başqalarının suallarına](help-fastapi.md#help-others-with-questions-in-github){.internal-link target=_blank} ən çox kömək edənlərdir. |
|||
|
|||
Onlar bir çox insanlara kömək edərək mütəxəssis olduqlarını sübut ediblər. ✨ |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.experts[:50] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Cavablandırılmış suallar: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## Ən yaxşı əməkdaşlar |
|||
|
|||
Burada **Ən yaxşı əməkdaşlar** var. 👷 |
|||
|
|||
Bu istifadəçilərin ən çox *birləşdirilmiş* [Pull Request-ləri var](help-fastapi.md#create-a-pull-request){.internal-link target=_blank}. |
|||
|
|||
Onlar mənbə kodu, sənədləmə, tərcümələr və s. barədə əmək göstərmişlər. 📦 |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.top_contributors[:50] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Pull Request-lər: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
Bundan başqa bir neçə (yüzdən çox) əməkdaş var ki, onları <a href="https://github.com/fastapi/fastapi/graphs/contributors" class="external-link" target="_blank">FastAPI GitHub Əməkdaşlar səhifəsində</a> görə bilərsiniz. 👷 |
|||
|
|||
## Ən çox rəy verənlər |
|||
|
|||
Bu istifadəçilər **ən çox rəy verənlər**dir. |
|||
|
|||
### Tərcümələr üçün rəylər |
|||
|
|||
Mən yalnız bir neçə dildə danışıram (və çox da yaxşı deyil 😅). Bu səbəbdən, rəy verənlər sənədlərin [**tərcümələrini təsdiqləmək üçün gücə malik olanlar**](contributing.md#translations){.internal-link target=_blank}dır. Onlar olmadan, bir çox dilə tərcümə olunmuş sənədlər olmazdı. |
|||
|
|||
--- |
|||
|
|||
Başqalarının Pull Request-lərinə **Ən çox rəy verənlər** 🕵️ kodun, sənədlərin və xüsusilə də **tərcümələrin** keyfiyyətini təmin edirlər. |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.top_translations_reviewers[:50] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Rəylər: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## Sponsorlar |
|||
|
|||
Bunlar **Sponsorlar**dır. 😎 |
|||
|
|||
Onlar mənim **FastAPI** (və digər) işlərimi əsasən <a href="https://github.com/sponsors/tiangolo" class="external-link" target="_blank">GitHub Sponsorlar</a> vasitəsilə dəstəkləyirlər. |
|||
|
|||
{% if sponsors %} |
|||
|
|||
{% if sponsors.gold %} |
|||
|
|||
### Qızıl Sponsorlar |
|||
|
|||
{% for sponsor in sponsors.gold -%} |
|||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% if sponsors.silver %} |
|||
|
|||
### Gümüş Sponsorlar |
|||
|
|||
{% for sponsor in sponsors.silver -%} |
|||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% if sponsors.bronze %} |
|||
|
|||
### Bürünc Sponsorlar |
|||
|
|||
{% for sponsor in sponsors.bronze -%} |
|||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% endif %} |
|||
|
|||
### Fərdi Sponsorlar |
|||
|
|||
{% if github_sponsors %} |
|||
{% for group in github_sponsors.sponsors %} |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in group %} |
|||
{% if user.login not in sponsors_badge.logins %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|||
|
|||
{% endif %} |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
## Məlumatlar haqqında - texniki detallar |
|||
|
|||
Bu səhifənin əsas məqsədi, icmanın başqalarına kömək etmək üçün göstərdiyi əməyi vurğulamaqdır. |
|||
|
|||
Xüsusilə də normalda daha az görünən və bir çox hallarda daha çətin olan, başqalarının suallarına kömək etmək və tərcümələrlə bağlı Pull Request-lərə rəy vermək kimi səy göstərmək. |
|||
|
|||
Bu səhifənin məlumatları hər ay hesablanır və siz <a href="https://github.com/fastapi/fastapi/blob/master/.github/actions/people/app/main.py" class="external-link" target="_blank">buradan mənbə kodunu</a> oxuya bilərsiniz. |
|||
|
|||
Burada sponsorların əməyini də vurğulamaq istəyirəm. |
|||
|
|||
Mən həmçinin alqoritmi, bölmələri, eşikləri və s. yeniləmək hüququnu da qoruyuram (hər ehtimala qarşı 🤷). |
|||
@ -1,42 +0,0 @@ |
|||
# Externe Links und Artikel |
|||
|
|||
**FastAPI** hat eine großartige Community, die ständig wächst. |
|||
|
|||
Es gibt viele Beiträge, Artikel, Tools und Projekte zum Thema **FastAPI**. |
|||
|
|||
Hier ist eine unvollständige Liste einiger davon. |
|||
|
|||
/// tip | "Tipp" |
|||
|
|||
Wenn Sie einen Artikel, ein Projekt, ein Tool oder irgendetwas im Zusammenhang mit **FastAPI** haben, was hier noch nicht aufgeführt ist, erstellen Sie einen <a href="https://github.com/fastapi/fastapi/edit/master/docs/en/data/external_links.yml" class="external-link" target="_blank">Pull Request und fügen Sie es hinzu</a>. |
|||
|
|||
/// |
|||
|
|||
/// note | "Hinweis Deutsche Übersetzung" |
|||
|
|||
Die folgenden Überschriften und Links werden aus einer <a href="https://github.com/fastapi/fastapi/blob/master/docs/en/data/external_links.yml" class="external-link" target="_blank">anderen Datei</a> gelesen und sind daher nicht ins Deutsche übersetzt. |
|||
|
|||
/// |
|||
|
|||
{% for section_name, section_content in external_links.items() %} |
|||
|
|||
## {{ section_name }} |
|||
|
|||
{% for lang_name, lang_content in section_content.items() %} |
|||
|
|||
### {{ lang_name }} |
|||
|
|||
{% for item in lang_content %} |
|||
|
|||
* <a href="{{ item.link }}" class="external-link" target="_blank">{{ item.title }}</a> by <a href="{{ item.author_link }}" class="external-link" target="_blank">{{ item.author }}</a>. |
|||
|
|||
{% endfor %} |
|||
{% endfor %} |
|||
{% endfor %} |
|||
|
|||
## Projekte |
|||
|
|||
Die neuesten GitHub-Projekte zum Thema `fastapi`: |
|||
|
|||
<div class="github-topic-projects"> |
|||
</div> |
|||
@ -1,176 +0,0 @@ |
|||
--- |
|||
hide: |
|||
- navigation |
|||
--- |
|||
|
|||
# FastAPI Leute |
|||
|
|||
FastAPI hat eine großartige Gemeinschaft, die Menschen mit unterschiedlichstem Hintergrund willkommen heißt. |
|||
|
|||
## Erfinder - Betreuer |
|||
|
|||
Hey! 👋 |
|||
|
|||
Das bin ich: |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.maintainers %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Answers: {{ user.answers }}</div><div class="count">Pull Requests: {{ user.prs }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
Ich bin der Erfinder und Betreuer von **FastAPI**. Sie können mehr darüber in [FastAPI helfen – Hilfe erhalten – Mit dem Autor vernetzen](help-fastapi.md#mit-dem-autor-vernetzen){.internal-link target=_blank} erfahren. |
|||
|
|||
... Aber hier möchte ich Ihnen die Gemeinschaft vorstellen. |
|||
|
|||
--- |
|||
|
|||
**FastAPI** erhält eine Menge Unterstützung aus der Gemeinschaft. Und ich möchte ihre Beiträge hervorheben. |
|||
|
|||
Das sind die Menschen, die: |
|||
|
|||
* [Anderen bei Fragen auf GitHub helfen](help-fastapi.md#anderen-bei-fragen-auf-github-helfen){.internal-link target=_blank}. |
|||
* [<abbr title='Pull Request – „Zieh-Anfrage“: Geänderten Quellcode senden, mit dem Vorschlag, ihn mit dem aktuellen Quellcode zu verschmelzen'>Pull Requests</abbr> erstellen](help-fastapi.md#einen-pull-request-erstellen){.internal-link target=_blank}. |
|||
* Pull Requests überprüfen (Review), [besonders wichtig für Übersetzungen](contributing.md#ubersetzungen){.internal-link target=_blank}. |
|||
|
|||
Eine Runde Applaus für sie. 👏 🙇 |
|||
|
|||
## Aktivste Benutzer im letzten Monat |
|||
|
|||
Hier die Benutzer, die im letzten Monat am meisten [anderen mit Fragen auf Github](help-fastapi.md#anderen-bei-fragen-auf-github-helfen){.internal-link target=_blank} geholfen haben. ☕ |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.last_month_active %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Fragen beantwortet: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## Experten |
|||
|
|||
Hier die **FastAPI-Experten**. 🤓 |
|||
|
|||
Das sind die Benutzer, die *insgesamt* [anderen am meisten mit Fragen auf GitHub geholfen haben](help-fastapi.md#anderen-bei-fragen-auf-github-helfen){.internal-link target=_blank}. |
|||
|
|||
Sie haben bewiesen, dass sie Experten sind, weil sie vielen anderen geholfen haben. ✨ |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.experts %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Fragen beantwortet: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## Top-Mitwirkende |
|||
|
|||
Hier sind die **Top-Mitwirkenden**. 👷 |
|||
|
|||
Diese Benutzer haben [die meisten Pull Requests erstellt](help-fastapi.md#einen-pull-request-erstellen){.internal-link target=_blank} welche *<abbr title="Mergen – Zusammenführen: Unterschiedliche Versionen eines Quellcodes zusammenführen">gemerged</abbr>* wurden. |
|||
|
|||
Sie haben Quellcode, Dokumentation, Übersetzungen, usw. beigesteuert. 📦 |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.top_contributors %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Pull Requests: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
Es gibt viele andere Mitwirkende (mehr als hundert), Sie können sie alle auf der <a href="https://github.com/fastapi/fastapi/graphs/contributors" class="external-link" target="_blank">FastAPI GitHub Contributors-Seite</a> sehen. 👷 |
|||
|
|||
## Top-Rezensenten |
|||
|
|||
Diese Benutzer sind die **Top-Rezensenten**. 🕵️ |
|||
|
|||
### Rezensionen für Übersetzungen |
|||
|
|||
Ich spreche nur ein paar Sprachen (und nicht sehr gut 😅). Daher bestätigen Reviewer [**Übersetzungen der Dokumentation**](contributing.md#ubersetzungen){.internal-link target=_blank}. Ohne sie gäbe es keine Dokumentation in mehreren anderen Sprachen. |
|||
|
|||
--- |
|||
|
|||
Die **Top-Reviewer** 🕵️ haben die meisten Pull Requests von anderen überprüft und stellen die Qualität des Codes, der Dokumentation und insbesondere der **Übersetzungen** sicher. |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.top_reviewers %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">Reviews: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## Sponsoren |
|||
|
|||
Dies sind die **Sponsoren**. 😎 |
|||
|
|||
Sie unterstützen meine Arbeit an **FastAPI** (und andere), hauptsächlich durch <a href="https://github.com/sponsors/tiangolo" class="external-link" target="_blank">GitHub-Sponsoren</a>. |
|||
|
|||
### Gold Sponsoren |
|||
|
|||
{% if sponsors %} |
|||
{% for sponsor in sponsors.gold -%} |
|||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
### Silber Sponsoren |
|||
|
|||
{% if sponsors %} |
|||
{% for sponsor in sponsors.silver -%} |
|||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% if people %} |
|||
{% if people.sponsors_50 %} |
|||
|
|||
### Bronze Sponsoren |
|||
|
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.sponsors_50 %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
{% endif %} |
|||
{% endif %} |
|||
|
|||
### Individuelle Sponsoren |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.sponsors %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## Über diese Daten - technische Details |
|||
|
|||
Der Hauptzweck dieser Seite ist es zu zeigen, wie die Gemeinschaft anderen hilft. |
|||
|
|||
Das beinhaltet auch Hilfe, die normalerweise weniger sichtbar und in vielen Fällen mühsamer ist, wie, anderen bei Problemen zu helfen und Pull Requests mit Übersetzungen zu überprüfen. |
|||
|
|||
Diese Daten werden jeden Monat berechnet, Sie können den <a href="https://github.com/fastapi/fastapi/blob/master/.github/actions/people/app/main.py" class="external-link" target="_blank">Quellcode hier lesen</a>. |
|||
|
|||
Hier weise ich auch auf Beiträge von Sponsoren hin. |
|||
|
|||
Ich behalte mir auch das Recht vor, den Algorithmus, die Abschnitte, die Schwellenwerte usw. zu aktualisieren (nur für den Fall 🤷). |
|||
@ -1,5 +0,0 @@ |
|||
# FastAPI und Freunde Newsletter |
|||
|
|||
<iframe data-w-type="embedded" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="https://xr4n4.mjt.lu/wgt/xr4n4/hj5/form?c=40a44fa4" width="100%" style="height: 0;"></iframe> |
|||
|
|||
<script type="text/javascript" src="https://app.mailjet.com/pas-nc-embedded-v1.js"></script> |
|||
@ -1,24 +0,0 @@ |
|||
# `APIRouter`-Klasse |
|||
|
|||
Hier sind die Referenzinformationen für die Klasse `APIRouter` mit all ihren Parametern, Attributen und Methoden. |
|||
|
|||
Sie können die `APIRouter`-Klasse direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import APIRouter |
|||
``` |
|||
|
|||
::: fastapi.APIRouter |
|||
options: |
|||
members: |
|||
- websocket |
|||
- include_router |
|||
- get |
|||
- put |
|||
- post |
|||
- delete |
|||
- options |
|||
- head |
|||
- patch |
|||
- trace |
|||
- on_event |
|||
@ -1,11 +0,0 @@ |
|||
# Hintergrundtasks – `BackgroundTasks` |
|||
|
|||
Sie können einen Parameter in einer *Pfadoperation-Funktion* oder einer Abhängigkeitsfunktion mit dem Typ `BackgroundTasks` deklarieren und diesen danach verwenden, um die Ausführung von Hintergrundtasks nach dem Senden der Response zu definieren. |
|||
|
|||
Sie können `BackgroundTasks` direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import BackgroundTasks |
|||
``` |
|||
|
|||
::: fastapi.BackgroundTasks |
|||
@ -1,29 +0,0 @@ |
|||
# Abhängigkeiten – `Depends()` und `Security()` |
|||
|
|||
## `Depends()` |
|||
|
|||
Abhängigkeiten werden hauptsächlich mit der speziellen Funktion `Depends()` behandelt, die ein Callable entgegennimmt. |
|||
|
|||
Hier finden Sie deren Referenz und Parameter. |
|||
|
|||
Sie können sie direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import Depends |
|||
``` |
|||
|
|||
::: fastapi.Depends |
|||
|
|||
## `Security()` |
|||
|
|||
In vielen Szenarien können Sie die Sicherheit (Autorisierung, Authentifizierung usw.) mit Abhängigkeiten handhaben, indem Sie `Depends()` verwenden. |
|||
|
|||
Wenn Sie jedoch auch OAuth2-Scopes deklarieren möchten, können Sie `Security()` anstelle von `Depends()` verwenden. |
|||
|
|||
Sie können `Security()` direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import Security |
|||
``` |
|||
|
|||
::: fastapi.Security |
|||
@ -1,3 +0,0 @@ |
|||
# Encoder – `jsonable_encoder` |
|||
|
|||
::: fastapi.encoders.jsonable_encoder |
|||
@ -1,20 +0,0 @@ |
|||
# Exceptions – `HTTPException` und `WebSocketException` |
|||
|
|||
Dies sind die <abbr title="Exception – Ausnahme, Fehler: Python-Objekt, das einen Fehler nebst Metadaten repräsentiert">Exceptions</abbr>, die Sie auslösen können, um dem Client Fehler zu berichten. |
|||
|
|||
Wenn Sie eine Exception auslösen, wird, wie es bei normalem Python der Fall wäre, der Rest der Ausführung abgebrochen. Auf diese Weise können Sie diese Exceptions von überall im Code werfen, um einen Request abzubrechen und den Fehler dem Client anzuzeigen. |
|||
|
|||
Sie können Folgendes verwenden: |
|||
|
|||
* `HTTPException` |
|||
* `WebSocketException` |
|||
|
|||
Diese Exceptions können direkt von `fastapi` importiert werden: |
|||
|
|||
```python |
|||
from fastapi import HTTPException, WebSocketException |
|||
``` |
|||
|
|||
::: fastapi.HTTPException |
|||
|
|||
::: fastapi.WebSocketException |
|||
@ -1,31 +0,0 @@ |
|||
# `FastAPI`-Klasse |
|||
|
|||
Hier sind die Referenzinformationen für die Klasse `FastAPI` mit all ihren Parametern, Attributen und Methoden. |
|||
|
|||
Sie können die `FastAPI`-Klasse direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import FastAPI |
|||
``` |
|||
|
|||
::: fastapi.FastAPI |
|||
options: |
|||
members: |
|||
- openapi_version |
|||
- webhooks |
|||
- state |
|||
- dependency_overrides |
|||
- openapi |
|||
- websocket |
|||
- include_router |
|||
- get |
|||
- put |
|||
- post |
|||
- delete |
|||
- options |
|||
- head |
|||
- patch |
|||
- trace |
|||
- on_event |
|||
- middleware |
|||
- exception_handler |
|||
@ -1,11 +0,0 @@ |
|||
# `HTTPConnection`-Klasse |
|||
|
|||
Wenn Sie Abhängigkeiten definieren möchten, die sowohl mit HTTP als auch mit WebSockets kompatibel sein sollen, können Sie einen Parameter definieren, der eine `HTTPConnection` anstelle eines `Request` oder eines `WebSocket` akzeptiert. |
|||
|
|||
Sie können diese von `fastapi.requests` importieren: |
|||
|
|||
```python |
|||
from fastapi.requests import HTTPConnection |
|||
``` |
|||
|
|||
::: fastapi.requests.HTTPConnection |
|||
@ -1,11 +0,0 @@ |
|||
# Referenz – Code-API |
|||
|
|||
Hier ist die Referenz oder Code-API, die Klassen, Funktionen, Parameter, Attribute und alle FastAPI-Teile, die Sie in Ihren Anwendungen verwenden können. |
|||
|
|||
Wenn Sie **FastAPI** lernen möchten, ist es viel besser, das [FastAPI-Tutorial](https://fastapi.tiangolo.com/tutorial/) zu lesen. |
|||
|
|||
/// note | "Hinweis Deutsche Übersetzung" |
|||
|
|||
Die nachfolgende API wird aus der Quelltext-Dokumentation erstellt, daher sind nur die Einleitungen auf Deutsch. |
|||
|
|||
/// |
|||
@ -1,45 +0,0 @@ |
|||
# Middleware |
|||
|
|||
Es gibt mehrere Middlewares, die direkt von Starlette bereitgestellt werden. |
|||
|
|||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation über Middleware](../advanced/middleware.md). |
|||
|
|||
::: fastapi.middleware.cors.CORSMiddleware |
|||
|
|||
Kann von `fastapi` importiert werden: |
|||
|
|||
```python |
|||
from fastapi.middleware.cors import CORSMiddleware |
|||
``` |
|||
|
|||
::: fastapi.middleware.gzip.GZipMiddleware |
|||
|
|||
Kann von `fastapi` importiert werden: |
|||
|
|||
```python |
|||
from fastapi.middleware.gzip import GZipMiddleware |
|||
``` |
|||
|
|||
::: fastapi.middleware.httpsredirect.HTTPSRedirectMiddleware |
|||
|
|||
Kann von `fastapi` importiert werden: |
|||
|
|||
```python |
|||
from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware |
|||
``` |
|||
|
|||
::: fastapi.middleware.trustedhost.TrustedHostMiddleware |
|||
|
|||
Kann von `fastapi` importiert werden: |
|||
|
|||
```python |
|||
from fastapi.middleware.trustedhost import TrustedHostMiddleware |
|||
``` |
|||
|
|||
::: fastapi.middleware.wsgi.WSGIMiddleware |
|||
|
|||
Kann von `fastapi` importiert werden: |
|||
|
|||
```python |
|||
from fastapi.middleware.wsgi import WSGIMiddleware |
|||
``` |
|||
@ -1,11 +0,0 @@ |
|||
# OpenAPI `docs` |
|||
|
|||
Werkzeuge zur Verwaltung der automatischen OpenAPI-UI-Dokumentation, einschließlich Swagger UI (standardmäßig unter `/docs`) und ReDoc (standardmäßig unter `/redoc`). |
|||
|
|||
::: fastapi.openapi.docs.get_swagger_ui_html |
|||
|
|||
::: fastapi.openapi.docs.get_redoc_html |
|||
|
|||
::: fastapi.openapi.docs.get_swagger_ui_oauth2_redirect_html |
|||
|
|||
::: fastapi.openapi.docs.swagger_ui_default_parameters |
|||
@ -1,5 +0,0 @@ |
|||
# OpenAPI |
|||
|
|||
Es gibt mehrere Werkzeuge zur Handhabung von OpenAPI. |
|||
|
|||
Normalerweise müssen Sie diese nicht verwenden, es sei denn, Sie haben einen bestimmten fortgeschrittenen Anwendungsfall, welcher das erfordert. |
|||
@ -1,5 +0,0 @@ |
|||
# OpenAPI-`models` |
|||
|
|||
OpenAPI Pydantic-Modelle, werden zum Generieren und Validieren der generierten OpenAPI verwendet. |
|||
|
|||
::: fastapi.openapi.models |
|||
@ -1,35 +0,0 @@ |
|||
# Request-Parameter |
|||
|
|||
Hier die Referenzinformationen für die Request-Parameter. |
|||
|
|||
Dies sind die Sonderfunktionen, die Sie mittels `Annotated` in *Pfadoperation-Funktion*-Parameter oder Abhängigkeitsfunktionen einfügen können, um Daten aus dem Request abzurufen. |
|||
|
|||
Dies beinhaltet: |
|||
|
|||
* `Query()` |
|||
* `Path()` |
|||
* `Body()` |
|||
* `Cookie()` |
|||
* `Header()` |
|||
* `Form()` |
|||
* `File()` |
|||
|
|||
Sie können diese alle direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import Body, Cookie, File, Form, Header, Path, Query |
|||
``` |
|||
|
|||
::: fastapi.Query |
|||
|
|||
::: fastapi.Path |
|||
|
|||
::: fastapi.Body |
|||
|
|||
::: fastapi.Cookie |
|||
|
|||
::: fastapi.Header |
|||
|
|||
::: fastapi.Form |
|||
|
|||
::: fastapi.File |
|||
@ -1,17 +0,0 @@ |
|||
# `Request`-Klasse |
|||
|
|||
Sie können einen Parameter in einer *Pfadoperation-Funktion* oder einer Abhängigkeit als vom Typ `Request` deklarieren und dann direkt auf das Requestobjekt zugreifen, ohne jegliche Validierung, usw. |
|||
|
|||
Sie können es direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import Request |
|||
``` |
|||
|
|||
/// tip | "Tipp" |
|||
|
|||
Wenn Sie Abhängigkeiten definieren möchten, die sowohl mit HTTP als auch mit WebSockets kompatibel sein sollen, können Sie einen Parameter definieren, der eine `HTTPConnection` anstelle eines `Request` oder eines `WebSocket` akzeptiert. |
|||
|
|||
/// |
|||
|
|||
::: fastapi.Request |
|||
@ -1,13 +0,0 @@ |
|||
# `Response`-Klasse |
|||
|
|||
Sie können einen Parameter in einer *Pfadoperation-Funktion* oder einer Abhängigkeit als `Response` deklarieren und dann Daten für die Response wie Header oder Cookies festlegen. |
|||
|
|||
Diese können Sie auch direkt verwenden, um eine Instanz davon zu erstellen und diese von Ihren *Pfadoperationen* zurückzugeben. |
|||
|
|||
Sie können sie direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import Response |
|||
``` |
|||
|
|||
::: fastapi.Response |
|||
@ -1,164 +0,0 @@ |
|||
# Benutzerdefinierte Responseklassen – File, HTML, Redirect, Streaming, usw. |
|||
|
|||
Es gibt mehrere benutzerdefinierte Responseklassen, von denen Sie eine Instanz erstellen und diese direkt von Ihren *Pfadoperationen* zurückgeben können. |
|||
|
|||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation zu benutzerdefinierten Responses – HTML, Stream, Datei, andere](../advanced/custom-response.md). |
|||
|
|||
Sie können diese direkt von `fastapi.responses` importieren: |
|||
|
|||
```python |
|||
from fastapi.responses import ( |
|||
FileResponse, |
|||
HTMLResponse, |
|||
JSONResponse, |
|||
ORJSONResponse, |
|||
PlainTextResponse, |
|||
RedirectResponse, |
|||
Response, |
|||
StreamingResponse, |
|||
UJSONResponse, |
|||
) |
|||
``` |
|||
|
|||
## FastAPI-Responses |
|||
|
|||
Es gibt einige benutzerdefinierte FastAPI-Responseklassen, welche Sie verwenden können, um die JSON-Performanz zu optimieren. |
|||
|
|||
::: fastapi.responses.UJSONResponse |
|||
options: |
|||
members: |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
|
|||
::: fastapi.responses.ORJSONResponse |
|||
options: |
|||
members: |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
|
|||
## Starlette-Responses |
|||
|
|||
::: fastapi.responses.FileResponse |
|||
options: |
|||
members: |
|||
- chunk_size |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
|
|||
::: fastapi.responses.HTMLResponse |
|||
options: |
|||
members: |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
|
|||
::: fastapi.responses.JSONResponse |
|||
options: |
|||
members: |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
|
|||
::: fastapi.responses.PlainTextResponse |
|||
options: |
|||
members: |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
|
|||
::: fastapi.responses.RedirectResponse |
|||
options: |
|||
members: |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
|
|||
::: fastapi.responses.Response |
|||
options: |
|||
members: |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
|
|||
::: fastapi.responses.StreamingResponse |
|||
options: |
|||
members: |
|||
- body_iterator |
|||
- charset |
|||
- status_code |
|||
- media_type |
|||
- body |
|||
- background |
|||
- raw_headers |
|||
- render |
|||
- init_headers |
|||
- headers |
|||
- set_cookie |
|||
- delete_cookie |
|||
@ -1,73 +0,0 @@ |
|||
# Sicherheitstools |
|||
|
|||
Wenn Sie Abhängigkeiten mit OAuth2-Scopes deklarieren müssen, verwenden Sie `Security()`. |
|||
|
|||
Aber Sie müssen immer noch definieren, was das <abbr title="Das von dem abhängt, die zu verwendende Abhängigkeit">Dependable</abbr>, das Callable ist, welches Sie als Parameter an `Depends()` oder `Security()` übergeben. |
|||
|
|||
Es gibt mehrere Tools, mit denen Sie diese Dependables erstellen können, und sie werden in OpenAPI integriert, sodass sie in der Oberfläche der automatischen Dokumentation angezeigt werden und von automatisch generierten Clients und SDKs, usw., verwendet werden können. |
|||
|
|||
Sie können sie von `fastapi.security` importieren: |
|||
|
|||
```python |
|||
from fastapi.security import ( |
|||
APIKeyCookie, |
|||
APIKeyHeader, |
|||
APIKeyQuery, |
|||
HTTPAuthorizationCredentials, |
|||
HTTPBasic, |
|||
HTTPBasicCredentials, |
|||
HTTPBearer, |
|||
HTTPDigest, |
|||
OAuth2, |
|||
OAuth2AuthorizationCodeBearer, |
|||
OAuth2PasswordBearer, |
|||
OAuth2PasswordRequestForm, |
|||
OAuth2PasswordRequestFormStrict, |
|||
OpenIdConnect, |
|||
SecurityScopes, |
|||
) |
|||
``` |
|||
|
|||
## API-Schlüssel-Sicherheitsschemas |
|||
|
|||
::: fastapi.security.APIKeyCookie |
|||
|
|||
::: fastapi.security.APIKeyHeader |
|||
|
|||
::: fastapi.security.APIKeyQuery |
|||
|
|||
## HTTP-Authentifizierungsschemas |
|||
|
|||
::: fastapi.security.HTTPBasic |
|||
|
|||
::: fastapi.security.HTTPBearer |
|||
|
|||
::: fastapi.security.HTTPDigest |
|||
|
|||
## HTTP-Anmeldeinformationen |
|||
|
|||
::: fastapi.security.HTTPAuthorizationCredentials |
|||
|
|||
::: fastapi.security.HTTPBasicCredentials |
|||
|
|||
## OAuth2-Authentifizierung |
|||
|
|||
::: fastapi.security.OAuth2 |
|||
|
|||
::: fastapi.security.OAuth2AuthorizationCodeBearer |
|||
|
|||
::: fastapi.security.OAuth2PasswordBearer |
|||
|
|||
## OAuth2-Passwortformulare |
|||
|
|||
::: fastapi.security.OAuth2PasswordRequestForm |
|||
|
|||
::: fastapi.security.OAuth2PasswordRequestFormStrict |
|||
|
|||
## OAuth2-Sicherheitsscopes in Abhängigkeiten |
|||
|
|||
::: fastapi.security.SecurityScopes |
|||
|
|||
## OpenID Connect |
|||
|
|||
::: fastapi.security.OpenIdConnect |
|||
@ -1,13 +0,0 @@ |
|||
# Statische Dateien – `StaticFiles` |
|||
|
|||
Sie können die `StaticFiles`-Klasse verwenden, um statische Dateien wie JavaScript, CSS, Bilder, usw. bereitzustellen. |
|||
|
|||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation zu statischen Dateien](../tutorial/static-files.md). |
|||
|
|||
Sie können sie direkt von `fastapi.staticfiles` importieren: |
|||
|
|||
```python |
|||
from fastapi.staticfiles import StaticFiles |
|||
``` |
|||
|
|||
::: fastapi.staticfiles.StaticFiles |
|||
@ -1,36 +0,0 @@ |
|||
# Statuscodes |
|||
|
|||
Sie können das Modul `status` von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import status |
|||
``` |
|||
|
|||
`status` wird direkt von Starlette bereitgestellt. |
|||
|
|||
Es enthält eine Gruppe benannter Konstanten (Variablen) mit ganzzahligen Statuscodes. |
|||
|
|||
Zum Beispiel: |
|||
|
|||
* 200: `status.HTTP_200_OK` |
|||
* 403: `status.HTTP_403_FORBIDDEN` |
|||
* usw. |
|||
|
|||
Es kann praktisch sein, schnell auf HTTP- (und WebSocket-)Statuscodes in Ihrer Anwendung zuzugreifen, indem Sie die automatische Vervollständigung für den Namen verwenden, ohne sich die Zahlen für die Statuscodes merken zu müssen. |
|||
|
|||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation zu Response-Statuscodes](../tutorial/response-status-code.md). |
|||
|
|||
## Beispiel |
|||
|
|||
```python |
|||
from fastapi import FastAPI, status |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
@app.get("/items/", status_code=status.HTTP_418_IM_A_TEAPOT) |
|||
def read_items(): |
|||
return [{"name": "Plumbus"}, {"name": "Portal Gun"}] |
|||
``` |
|||
|
|||
::: fastapi.status |
|||
@ -1,13 +0,0 @@ |
|||
# Templating – `Jinja2Templates` |
|||
|
|||
Sie können die `Jinja2Templates`-Klasse verwenden, um Jinja-Templates zu rendern. |
|||
|
|||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation zu Templates](../advanced/templates.md). |
|||
|
|||
Sie können die Klasse direkt von `fastapi.templating` importieren: |
|||
|
|||
```python |
|||
from fastapi.templating import Jinja2Templates |
|||
``` |
|||
|
|||
::: fastapi.templating.Jinja2Templates |
|||
@ -1,13 +0,0 @@ |
|||
# Testclient – `TestClient` |
|||
|
|||
Sie können die `TestClient`-Klasse verwenden, um FastAPI-Anwendungen zu testen, ohne eine tatsächliche HTTP- und Socket-Verbindung zu erstellen, Sie kommunizieren einfach direkt mit dem FastAPI-Code. |
|||
|
|||
Lesen Sie mehr darüber in der [FastAPI-Dokumentation über Testen](../tutorial/testing.md). |
|||
|
|||
Sie können sie direkt von `fastapi.testclient` importieren: |
|||
|
|||
```python |
|||
from fastapi.testclient import TestClient |
|||
``` |
|||
|
|||
::: fastapi.testclient.TestClient |
|||
@ -1,22 +0,0 @@ |
|||
# `UploadFile`-Klasse |
|||
|
|||
Sie können *Pfadoperation-Funktionsparameter* als Parameter vom Typ `UploadFile` definieren, um Dateien aus dem Request zu erhalten. |
|||
|
|||
Sie können es direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import UploadFile |
|||
``` |
|||
|
|||
::: fastapi.UploadFile |
|||
options: |
|||
members: |
|||
- file |
|||
- filename |
|||
- size |
|||
- headers |
|||
- content_type |
|||
- read |
|||
- write |
|||
- seek |
|||
- close |
|||
@ -1,67 +0,0 @@ |
|||
# WebSockets |
|||
|
|||
Bei der Definition von WebSockets deklarieren Sie normalerweise einen Parameter vom Typ `WebSocket` und können damit Daten vom Client lesen und an ihn senden. Er wird direkt von Starlette bereitgestellt, Sie können ihn aber von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import WebSocket |
|||
``` |
|||
|
|||
/// tip | "Tipp" |
|||
|
|||
Wenn Sie Abhängigkeiten definieren möchten, die sowohl mit HTTP als auch mit WebSockets kompatibel sein sollen, können Sie einen Parameter definieren, der eine `HTTPConnection` anstelle eines `Request` oder eines `WebSocket` akzeptiert. |
|||
|
|||
/// |
|||
|
|||
::: fastapi.WebSocket |
|||
options: |
|||
members: |
|||
- scope |
|||
- app |
|||
- url |
|||
- base_url |
|||
- headers |
|||
- query_params |
|||
- path_params |
|||
- cookies |
|||
- client |
|||
- state |
|||
- url_for |
|||
- client_state |
|||
- application_state |
|||
- receive |
|||
- send |
|||
- accept |
|||
- receive_text |
|||
- receive_bytes |
|||
- receive_json |
|||
- iter_text |
|||
- iter_bytes |
|||
- iter_json |
|||
- send_text |
|||
- send_bytes |
|||
- send_json |
|||
- close |
|||
|
|||
Wenn ein Client die Verbindung trennt, wird eine `WebSocketDisconnect`-Exception ausgelöst, die Sie abfangen können. |
|||
|
|||
Sie können diese direkt von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi import WebSocketDisconnect |
|||
``` |
|||
|
|||
::: fastapi.WebSocketDisconnect |
|||
|
|||
## WebSockets – zusätzliche Klassen |
|||
|
|||
Zusätzliche Klassen für die Handhabung von WebSockets. |
|||
|
|||
Werden direkt von Starlette bereitgestellt, Sie können sie jedoch von `fastapi` importieren: |
|||
|
|||
```python |
|||
from fastapi.websockets import WebSocketDisconnect, WebSocketState |
|||
``` |
|||
|
|||
::: fastapi.websockets.WebSocketDisconnect |
|||
|
|||
::: fastapi.websockets.WebSocketState |
|||
@ -1,38 +0,0 @@ |
|||
# 🔢 🔗 & 📄 |
|||
|
|||
**FastAPI** ✔️ 👑 👪 🕧 💗. |
|||
|
|||
📤 📚 🏤, 📄, 🧰, & 🏗, 🔗 **FastAPI**. |
|||
|
|||
📥 ❌ 📇 👫. |
|||
|
|||
/// tip |
|||
|
|||
🚥 👆 ✔️ 📄, 🏗, 🧰, ⚖️ 🕳 🔗 **FastAPI** 👈 🚫 📇 📥, ✍ <a href="https://github.com/fastapi/fastapi/edit/master/docs/en/data/external_links.yml" class="external-link" target="_blank">🚲 📨 ❎ ⚫️</a>. |
|||
|
|||
/// |
|||
|
|||
## 📄 |
|||
|
|||
{% for section_name, section_content in external_links.items() %} |
|||
|
|||
## {{ section_name }} |
|||
|
|||
{% for lang_name, lang_content in section_content.items() %} |
|||
|
|||
### {{ lang_name }} |
|||
|
|||
{% for item in lang_content %} |
|||
|
|||
* <a href="{{ item.link }}" class="external-link" target="_blank">{{ item.title }}</a> by <a href="{{ item.author_link }}" class="external-link" target="_blank">{{ item.author }}</a>. |
|||
|
|||
{% endfor %} |
|||
{% endfor %} |
|||
{% endfor %} |
|||
|
|||
## 🏗 |
|||
|
|||
⏪ 📂 🏗 ⏮️ ❔ `fastapi`: |
|||
|
|||
<div class="github-topic-projects"> |
|||
</div> |
|||
@ -1,183 +0,0 @@ |
|||
--- |
|||
hide: |
|||
- navigation |
|||
--- |
|||
|
|||
# FastAPI 👫👫 |
|||
|
|||
FastAPI ✔️ 🎆 👪 👈 🙋 👫👫 ⚪️➡️ 🌐 🖥. |
|||
|
|||
## 👼 - 🐛 |
|||
|
|||
🙋 ❗ 👶 |
|||
|
|||
👉 👤: |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.maintainers %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">❔: {{ user.answers }}</div><div class="count">🚲 📨: {{ user.prs }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
👤 👼 & 🐛 **FastAPI**. 👆 💪 ✍ 🌅 🔃 👈 [ℹ FastAPI - 🤚 ℹ - 🔗 ⏮️ 📕](help-fastapi.md#_3){.internal-link target=_blank}. |
|||
|
|||
...✋️ 📥 👤 💚 🎦 👆 👪. |
|||
|
|||
--- |
|||
|
|||
**FastAPI** 📨 📚 🐕🦺 ⚪️➡️ 👪. & 👤 💚 🎦 👫 💰. |
|||
|
|||
👫 👫👫 👈: |
|||
|
|||
* [ℹ 🎏 ⏮️ ❔ 📂](help-fastapi.md#i){.internal-link target=_blank}. |
|||
* [✍ 🚲 📨](help-fastapi.md#_15){.internal-link target=_blank}. |
|||
* 📄 🚲 📨, [✴️ ⚠ ✍](contributing.md#_9){.internal-link target=_blank}. |
|||
|
|||
👏 👫. 👶 👶 |
|||
|
|||
## 🌅 🦁 👩💻 🏁 🗓️ |
|||
|
|||
👫 👩💻 👈 ✔️ [🤝 🎏 🏆 ⏮️ ❔ 📂](help-fastapi.md#i){.internal-link target=_blank} ⏮️ 🏁 🗓️. 👶 |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.last_month_experts[:10] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">❔ 📨: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## 🕴 |
|||
|
|||
📥 **FastAPI 🕴**. 👶 |
|||
|
|||
👫 👩💻 👈 ✔️ [ℹ 🎏 🏆 ⏮️ ❔ 📂](help-fastapi.md#i){.internal-link target=_blank} 🔘 *🌐 🕰*. |
|||
|
|||
👫 ✔️ 🎦 🕴 🤝 📚 🎏. 👶 |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.experts[:50] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">❔ 📨: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## 🔝 👨🔬 |
|||
|
|||
📥 **🔝 👨🔬**. 👶 |
|||
|
|||
👉 👩💻 ✔️ [✍ 🏆 🚲 📨](help-fastapi.md#_15){.internal-link target=_blank} 👈 ✔️ *🔗*. |
|||
|
|||
👫 ✔️ 📉 ℹ 📟, 🧾, ✍, ♒️. 👶 |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.top_contributors[:50] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">🚲 📨: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
📤 📚 🎏 👨🔬 (🌅 🌘 💯), 👆 💪 👀 👫 🌐 <a href="https://github.com/fastapi/fastapi/graphs/contributors" class="external-link" target="_blank">FastAPI 📂 👨🔬 📃</a>. 👶 |
|||
|
|||
## 🔝 👨🔬 |
|||
|
|||
👫 👩💻 **🔝 👨🔬**. 👶 👶 |
|||
|
|||
### 📄 ✍ |
|||
|
|||
👤 🕴 💬 👩❤👨 🇪🇸 (& 🚫 📶 👍 👶). , 👨🔬 🕐 👈 ✔️ [**🏋️ ✔ ✍**](contributing.md#_9){.internal-link target=_blank} 🧾. 🍵 👫, 📤 🚫🔜 🧾 📚 🎏 🇪🇸. |
|||
|
|||
--- |
|||
|
|||
**🔝 👨🔬** 👶 👶 ✔️ 📄 🏆 🚲 📨 ⚪️➡️ 🎏, 🚚 🔆 📟, 🧾, & ✴️, **✍**. |
|||
|
|||
{% if people %} |
|||
<div class="user-list user-list-center"> |
|||
{% for user in people.top_translations_reviewers[:50] %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a> <div class="count">📄: {{ user.count }}</div></div> |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
{% endif %} |
|||
|
|||
## 💰 |
|||
|
|||
👫 **💰**. 👶 |
|||
|
|||
👫 🔗 👇 👷 ⏮️ **FastAPI** (& 🎏), ✴️ 🔘 <a href="https://github.com/sponsors/tiangolo" class="external-link" target="_blank">📂 💰</a>. |
|||
|
|||
{% if sponsors %} |
|||
|
|||
{% if sponsors.gold %} |
|||
|
|||
### 🌟 💰 |
|||
|
|||
{% for sponsor in sponsors.gold -%} |
|||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% if sponsors.silver %} |
|||
|
|||
### 🥇1st 💰 |
|||
|
|||
{% for sponsor in sponsors.silver -%} |
|||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% if sponsors.bronze %} |
|||
|
|||
### 🥈2nd 💰 |
|||
|
|||
{% for sponsor in sponsors.bronze -%} |
|||
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> |
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
{% endif %} |
|||
|
|||
### 🎯 💰 |
|||
|
|||
{% if github_sponsors %} |
|||
{% for group in github_sponsors.sponsors %} |
|||
|
|||
<div class="user-list user-list-center"> |
|||
|
|||
{% for user in group %} |
|||
{% if user.login not in sponsors_badge.logins %} |
|||
|
|||
<div class="user"><a href="{{ user.url }}" target="_blank"><div class="avatar-wrapper"><img src="{{ user.avatarUrl }}"/></div><div class="title">@{{ user.login }}</div></a></div> |
|||
|
|||
{% endif %} |
|||
{% endfor %} |
|||
|
|||
</div> |
|||
|
|||
{% endfor %} |
|||
{% endif %} |
|||
|
|||
## 🔃 📊 - 📡 ℹ |
|||
|
|||
👑 🎯 👉 📃 🎦 🎯 👪 ℹ 🎏. |
|||
|
|||
✴️ ✅ 🎯 👈 🛎 🌘 ⭐, & 📚 💼 🌅 😩, 💖 🤝 🎏 ⏮️ ❔ & ⚖ 🚲 📨 ⏮️ ✍. |
|||
|
|||
💽 ⚖ 🔠 🗓️, 👆 💪 ✍ <a href="https://github.com/fastapi/fastapi/blob/master/.github/actions/people/app/main.py" class="external-link" target="_blank">ℹ 📟 📥</a>. |
|||
|
|||
📥 👤 🎦 💰 ⚪️➡️ 💰. |
|||
|
|||
👤 🏦 ▶️️ ℹ 📊, 📄, ⚡, ♒️ (💼 🤷). |
|||
@ -1,19 +1,19 @@ |
|||
members: |
|||
- login: tiangolo |
|||
avatar_url: https://github.com/tiangolo.png |
|||
avatar_url: https://avatars.githubusercontent.com/u/1326112 |
|||
url: https://github.com/tiangolo |
|||
- login: Kludex |
|||
avatar_url: https://github.com/Kludex.png |
|||
avatar_url: https://avatars.githubusercontent.com/u/7353520 |
|||
url: https://github.com/Kludex |
|||
- login: alejsdev |
|||
avatar_url: https://github.com/alejsdev.png |
|||
avatar_url: https://avatars.githubusercontent.com/u/90076947 |
|||
url: https://github.com/alejsdev |
|||
- login: svlandeg |
|||
avatar_url: https://github.com/svlandeg.png |
|||
avatar_url: https://avatars.githubusercontent.com/u/8796347 |
|||
url: https://github.com/svlandeg |
|||
- login: estebanx64 |
|||
avatar_url: https://github.com/estebanx64.png |
|||
avatar_url: https://avatars.githubusercontent.com/u/10840422 |
|||
url: https://github.com/estebanx64 |
|||
- login: patrick91 |
|||
avatar_url: https://github.com/patrick91.png |
|||
avatar_url: https://avatars.githubusercontent.com/u/667029 |
|||
url: https://github.com/patrick91 |
|||
|
|||
@ -0,0 +1,300 @@ |
|||
# Environment Variables |
|||
|
|||
/// tip |
|||
|
|||
If you already know what "environment variables" are and how to use them, feel free to skip this. |
|||
|
|||
/// |
|||
|
|||
An environment variable (also known as "**env var**") is a variable that lives **outside** of the Python code, in the **operating system**, and could be read by your Python code (or by other programs as well). |
|||
|
|||
Environment variables could be useful for handling application **settings**, as part of the **installation** of Python, etc. |
|||
|
|||
## Create and Use Env Vars |
|||
|
|||
You can **create** and use environment variables in the **shell (terminal)**, without needing Python: |
|||
|
|||
//// tab | Linux, macOS, Windows Bash |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
// You could create an env var MY_NAME with |
|||
$ export MY_NAME="Wade Wilson" |
|||
|
|||
// Then you could use it with other programs, like |
|||
$ echo "Hello $MY_NAME" |
|||
|
|||
Hello Wade Wilson |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows PowerShell |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
// Create an env var MY_NAME |
|||
$ $Env:MY_NAME = "Wade Wilson" |
|||
|
|||
// Use it with other programs, like |
|||
$ echo "Hello $Env:MY_NAME" |
|||
|
|||
Hello Wade Wilson |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
## Read env vars in Python |
|||
|
|||
You could also create environment variables **outside** of Python, in the terminal (or with any other method), and then **read them in Python**. |
|||
|
|||
For example you could have a file `main.py` with: |
|||
|
|||
```Python hl_lines="3" |
|||
import os |
|||
|
|||
name = os.getenv("MY_NAME", "World") |
|||
print(f"Hello {name} from Python") |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
The second argument to <a href="https://docs.python.org/3.8/library/os.html#os.getenv" class="external-link" target="_blank">`os.getenv()`</a> is the default value to return. |
|||
|
|||
If not provided, it's `None` by default, here we provide `"World"` as the default value to use. |
|||
|
|||
/// |
|||
|
|||
Then you could call that Python program: |
|||
|
|||
//// tab | Linux, macOS, Windows Bash |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
// Here we don't set the env var yet |
|||
$ python main.py |
|||
|
|||
// As we didn't set the env var, we get the default value |
|||
|
|||
Hello World from Python |
|||
|
|||
// But if we create an environment variable first |
|||
$ export MY_NAME="Wade Wilson" |
|||
|
|||
// And then call the program again |
|||
$ python main.py |
|||
|
|||
// Now it can read the environment variable |
|||
|
|||
Hello Wade Wilson from Python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows PowerShell |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
// Here we don't set the env var yet |
|||
$ python main.py |
|||
|
|||
// As we didn't set the env var, we get the default value |
|||
|
|||
Hello World from Python |
|||
|
|||
// But if we create an environment variable first |
|||
$ $Env:MY_NAME = "Wade Wilson" |
|||
|
|||
// And then call the program again |
|||
$ python main.py |
|||
|
|||
// Now it can read the environment variable |
|||
|
|||
Hello Wade Wilson from Python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
As environment variables can be set outside of the code, but can be read by the code, and don't have to be stored (committed to `git`) with the rest of the files, it's common to use them for configurations or **settings**. |
|||
|
|||
You can also create an environment variable only for a **specific program invocation**, that is only available to that program, and only for its duration. |
|||
|
|||
To do that, create it right before the program itself, on the same line: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
// Create an env var MY_NAME in line for this program call |
|||
$ MY_NAME="Wade Wilson" python main.py |
|||
|
|||
// Now it can read the environment variable |
|||
|
|||
Hello Wade Wilson from Python |
|||
|
|||
// The env var no longer exists afterwards |
|||
$ python main.py |
|||
|
|||
Hello World from Python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
/// tip |
|||
|
|||
You can read more about it at <a href="https://12factor.net/config" class="external-link" target="_blank">The Twelve-Factor App: Config</a>. |
|||
|
|||
/// |
|||
|
|||
## Types and Validation |
|||
|
|||
These environment variables can only handle **text strings**, as they are external to Python and have to be compatible with other programs and the rest of the system (and even with different operating systems, as Linux, Windows, macOS). |
|||
|
|||
That means that **any value** read in Python from an environment variable **will be a `str`**, and any conversion to a different type or any validation has to be done in code. |
|||
|
|||
You will learn more about using environment variables for handling **application settings** in the [Advanced User Guide - Settings and Environment Variables](./advanced/settings.md){.internal-link target=_blank}. |
|||
|
|||
## `PATH` Environment Variable |
|||
|
|||
There is a **special** environment variable called **`PATH`** that is used by the operating systems (Linux, macOS, Windows) to find programs to run. |
|||
|
|||
The value of the variable `PATH` is a long string that is made of directories separated by a colon `:` on Linux and macOS, and by a semicolon `;` on Windows. |
|||
|
|||
For example, the `PATH` environment variable could look like this: |
|||
|
|||
//// tab | Linux, macOS |
|||
|
|||
```plaintext |
|||
/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin |
|||
``` |
|||
|
|||
This means that the system should look for programs in the directories: |
|||
|
|||
* `/usr/local/bin` |
|||
* `/usr/bin` |
|||
* `/bin` |
|||
* `/usr/sbin` |
|||
* `/sbin` |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows |
|||
|
|||
```plaintext |
|||
C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32 |
|||
``` |
|||
|
|||
This means that the system should look for programs in the directories: |
|||
|
|||
* `C:\Program Files\Python312\Scripts` |
|||
* `C:\Program Files\Python312` |
|||
* `C:\Windows\System32` |
|||
|
|||
//// |
|||
|
|||
When you type a **command** in the terminal, the operating system **looks for** the program in **each of those directories** listed in the `PATH` environment variable. |
|||
|
|||
For example, when you type `python` in the terminal, the operating system looks for a program called `python` in the **first directory** in that list. |
|||
|
|||
If it finds it, then it will **use it**. Otherwise it keeps looking in the **other directories**. |
|||
|
|||
### Installing Python and Updating the `PATH` |
|||
|
|||
When you install Python, you might be asked if you want to update the `PATH` environment variable. |
|||
|
|||
//// tab | Linux, macOS |
|||
|
|||
Let's say you install Python and it ends up in a directory `/opt/custompython/bin`. |
|||
|
|||
If you say yes to update the `PATH` environment variable, then the installer will add `/opt/custompython/bin` to the `PATH` environment variable. |
|||
|
|||
It could look like this: |
|||
|
|||
```plaintext |
|||
/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/custompython/bin |
|||
``` |
|||
|
|||
This way, when you type `python` in the terminal, the system will find the Python program in `/opt/custompython/bin` (the last directory) and use that one. |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows |
|||
|
|||
Let's say you install Python and it ends up in a directory `C:\opt\custompython\bin`. |
|||
|
|||
If you say yes to update the `PATH` environment variable, then the installer will add `C:\opt\custompython\bin` to the `PATH` environment variable. |
|||
|
|||
```plaintext |
|||
C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32;C:\opt\custompython\bin |
|||
``` |
|||
|
|||
This way, when you type `python` in the terminal, the system will find the Python program in `C:\opt\custompython\bin` (the last directory) and use that one. |
|||
|
|||
//// |
|||
|
|||
This way, when you type `python` in the terminal, the system will find the Python program in `/opt/custompython/bin` (the last directory) and use that one. |
|||
|
|||
So, if you type: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// tab | Linux, macOS |
|||
|
|||
The system will **find** the `python` program in `/opt/custompython/bin` and run it. |
|||
|
|||
It would be roughly equivalent to typing: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ /opt/custompython/bin/python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows |
|||
|
|||
The system will **find** the `python` program in `C:\opt\custompython\bin\python` and run it. |
|||
|
|||
It would be roughly equivalent to typing: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ C:\opt\custompython\bin\python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
This information will be useful when learning about [Virtual Environments](virtual-environments.md){.internal-link target=_blank}. |
|||
|
|||
## Conclusion |
|||
|
|||
With this you should have a basic understanding of what **environment variables** are and how to use them in Python. |
|||
|
|||
You can also read more about them in the <a href="https://en.wikipedia.org/wiki/Environment_variable" class="external-link" target="_blank">Wikipedia for Environment Variable</a>. |
|||
|
|||
In many cases it's not very obvious how environment variables would be useful and applicable right away. But they keep showing up in many different scenarios when you are developing, so it's good to know about them. |
|||
|
|||
For example, you will need this information in the next section, about [Virtual Environments](virtual-environments.md). |
|||
@ -0,0 +1,844 @@ |
|||
# Virtual Environments |
|||
|
|||
When you work in Python projects you probably should use a **virtual environment** (or a similar mechanism) to isolate the packages you install for each project. |
|||
|
|||
/// info |
|||
|
|||
If you already know about virtual environments, how to create them and use them, you might want to skip this section. 🤓 |
|||
|
|||
/// |
|||
|
|||
/// tip |
|||
|
|||
A **virtual environment** is different than an **environment variable**. |
|||
|
|||
An **environment variable** is a variable in the system that can be used by programs. |
|||
|
|||
A **virtual environment** is a directory with some files in it. |
|||
|
|||
/// |
|||
|
|||
/// info |
|||
|
|||
This page will teach you how to use **virtual environments** and how they work. |
|||
|
|||
If you are ready to adopt a **tool that manages everything** for you (including installing Python), try <a href="https://github.com/astral-sh/uv" class="external-link" target="_blank">uv</a>. |
|||
|
|||
/// |
|||
|
|||
## Create a Project |
|||
|
|||
First, create a directory for your project. |
|||
|
|||
What I normally do is that I create a directory named `code` inside my home/user directory. |
|||
|
|||
And inside of that I create one directory per project. |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
// Go to the home directory |
|||
$ cd |
|||
// Create a directory for all your code projects |
|||
$ mkdir code |
|||
// Enter into that code directory |
|||
$ cd code |
|||
// Create a directory for this project |
|||
$ mkdir awesome-project |
|||
// Enter into that project directory |
|||
$ cd awesome-project |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
## Create a Virtual Environment |
|||
|
|||
When you start working on a Python project **for the first time**, create a virtual environment **<abbr title="there are other options, this is a simple guideline">inside your project</abbr>**. |
|||
|
|||
/// tip |
|||
|
|||
You only need to do this **once per project**, not every time you work. |
|||
|
|||
/// |
|||
|
|||
//// tab | `venv` |
|||
|
|||
To create a virtual environment, you can use the `venv` module that comes with Python. |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ python -m venv .venv |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
/// details | What that command means |
|||
|
|||
* `python`: use the program called `python` |
|||
* `-m`: call a module as a script, we'll tell it which module next |
|||
* `venv`: use the module called `venv` that normally comes installed with Python |
|||
* `.venv`: create the virtual environment in the new directory `.venv` |
|||
|
|||
/// |
|||
|
|||
//// |
|||
|
|||
//// tab | `uv` |
|||
|
|||
If you have <a href="https://github.com/astral-sh/uv" class="external-link" target="_blank">`uv`</a> installed, you can use it to create a virtual environment. |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ uv venv |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
/// tip |
|||
|
|||
By default, `uv` will create a virtual environment in a directory called `.venv`. |
|||
|
|||
But you could customize it passing an additional argument with the directory name. |
|||
|
|||
/// |
|||
|
|||
//// |
|||
|
|||
That command creates a new virtual environment in a directory called `.venv`. |
|||
|
|||
/// details | `.venv` or other name |
|||
|
|||
You could create the virtual environment in a different directory, but there's a convention of calling it `.venv`. |
|||
|
|||
/// |
|||
|
|||
## Activate the Virtual Environment |
|||
|
|||
Activate the new virtual environment so that any Python command you run or package you install uses it. |
|||
|
|||
/// tip |
|||
|
|||
Do this **every time** you start a **new terminal session** to work on the project. |
|||
|
|||
/// |
|||
|
|||
//// tab | Linux, macOS |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ source .venv/bin/activate |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows PowerShell |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ .venv\Scripts\Activate.ps1 |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows Bash |
|||
|
|||
Or if you use Bash for Windows (e.g. <a href="https://gitforwindows.org/" class="external-link" target="_blank">Git Bash</a>): |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ source .venv/Scripts/activate |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
/// tip |
|||
|
|||
Every time you install a **new package** in that environment, **activate** the environment again. |
|||
|
|||
This makes sure that if you use a **terminal (<abbr title="command line interface">CLI</abbr>) program** installed by that package, you use the one from your virtual environment and not any other that could be installed globally, probably with a different version than what you need. |
|||
|
|||
/// |
|||
|
|||
## Check the Virtual Environment is Active |
|||
|
|||
Check that the virtual environment is active (the previous command worked). |
|||
|
|||
/// tip |
|||
|
|||
This is **optional**, but it's a good way to **check** that everything is working as expected and you are using the virtual environment you intended. |
|||
|
|||
/// |
|||
|
|||
//// tab | Linux, macOS, Windows Bash |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ which python |
|||
|
|||
/home/user/code/awesome-project/.venv/bin/python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
If it shows the `python` binary at `.venv/bin/python`, inside of your project (in this case `awesome-project`), then it worked. 🎉 |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows PowerShell |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ Get-Command python |
|||
|
|||
C:\Users\user\code\awesome-project\.venv\Scripts\python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
If it shows the `python` binary at `.venv\Scripts\python`, inside of your project (in this case `awesome-project`), then it worked. 🎉 |
|||
|
|||
//// |
|||
|
|||
## Upgrade `pip` |
|||
|
|||
/// tip |
|||
|
|||
If you use <a href="https://github.com/astral-sh/uv" class="external-link" target="_blank">`uv`</a> you would use it to install things instead of `pip`, so you don't need to upgrade `pip`. 😎 |
|||
|
|||
/// |
|||
|
|||
If you are using `pip` to install packages (it comes by default with Python), you should **upgrade** it to the latest version. |
|||
|
|||
Many exotic errors while installing a package are solved by just upgrading `pip` first. |
|||
|
|||
/// tip |
|||
|
|||
You would normally do this **once**, right after you create the virtual environment. |
|||
|
|||
/// |
|||
|
|||
Make sure the virtual environment is active (with the command above) and then run: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ python -m pip install --upgrade pip |
|||
|
|||
---> 100% |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
## Add `.gitignore` |
|||
|
|||
If you are using **Git** (you should), add a `.gitignore` file to exclude everything in your `.venv` from Git. |
|||
|
|||
/// tip |
|||
|
|||
If you used <a href="https://github.com/astral-sh/uv" class="external-link" target="_blank">`uv`</a> to create the virtual environment, it already did this for you, you can skip this step. 😎 |
|||
|
|||
/// |
|||
|
|||
/// tip |
|||
|
|||
Do this **once**, right after you create the virtual environment. |
|||
|
|||
/// |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ echo "*" > .venv/.gitignore |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
/// details | What that command means |
|||
|
|||
* `echo "*"`: will "print" the text `*` in the terminal (the next part changes that a bit) |
|||
* `>`: anything printed to the terminal by the command to the left of `>` should not be printed but instead written to the file that goes to the right of `>` |
|||
* `.gitignore`: the name of the file where the text should be written |
|||
|
|||
And `*` for Git means "everything". So, it will ignore everything in the `.venv` directory. |
|||
|
|||
That command will create a file `.gitignore` with the content: |
|||
|
|||
```gitignore |
|||
* |
|||
``` |
|||
|
|||
/// |
|||
|
|||
## Install Packages |
|||
|
|||
After activating the environment, you can install packages in it. |
|||
|
|||
/// tip |
|||
|
|||
Do this **once** when installing or upgrading the packages your project needs. |
|||
|
|||
If you need to upgrade a version or add a new package you would **do this again**. |
|||
|
|||
/// |
|||
|
|||
### Install Packages Directly |
|||
|
|||
If you're in a hurry and don't want to use a file to declare your project's package requirements, you can install them directly. |
|||
|
|||
/// tip |
|||
|
|||
It's a (very) good idea to put the packages and versions your program needs in a file (for example `requirements.txt` or `pyproject.toml`). |
|||
|
|||
/// |
|||
|
|||
//// tab | `pip` |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ pip install "fastapi[standard]" |
|||
|
|||
---> 100% |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | `uv` |
|||
|
|||
If you have <a href="https://github.com/astral-sh/uv" class="external-link" target="_blank">`uv`</a>: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ uv pip install "fastapi[standard]" |
|||
---> 100% |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
### Install from `requirements.txt` |
|||
|
|||
If you have a `requirements.txt`, you can now use it to install its packages. |
|||
|
|||
//// tab | `pip` |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ pip install -r requirements.txt |
|||
---> 100% |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | `uv` |
|||
|
|||
If you have <a href="https://github.com/astral-sh/uv" class="external-link" target="_blank">`uv`</a>: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ uv pip install -r requirements.txt |
|||
---> 100% |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
/// details | `requirements.txt` |
|||
|
|||
A `requirements.txt` with some packages could look like: |
|||
|
|||
```requirements.txt |
|||
fastapi[standard]==0.113.0 |
|||
pydantic==2.8.0 |
|||
``` |
|||
|
|||
/// |
|||
|
|||
## Run Your Program |
|||
|
|||
After you activated the virtual environment, you can run your program, and it will use the Python inside of your virtual environment with the packages you installed there. |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ python main.py |
|||
|
|||
Hello World |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
## Configure Your Editor |
|||
|
|||
You would probably use an editor, make sure you configure it to use the same virtual environment you created (it will probably autodetect it) so that you can get autocompletion and inline errors. |
|||
|
|||
For example: |
|||
|
|||
* <a href="https://code.visualstudio.com/docs/python/environments#_select-and-activate-an-environment" class="external-link" target="_blank">VS Code</a> |
|||
* <a href="https://www.jetbrains.com/help/pycharm/creating-virtual-environment.html" class="external-link" target="_blank">PyCharm</a> |
|||
|
|||
/// tip |
|||
|
|||
You normally have to do this only **once**, when you create the virtual environment. |
|||
|
|||
/// |
|||
|
|||
## Deactivate the Virtual Environment |
|||
|
|||
Once you are done working on your project you can **deactivate** the virtual environment. |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ deactivate |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
This way, when you run `python` it won't try to run it from that virtual environment with the packages installed there. |
|||
|
|||
## Ready to Work |
|||
|
|||
Now you're ready to start working on your project. |
|||
|
|||
|
|||
|
|||
/// tip |
|||
|
|||
Do you want to understand what's all that above? |
|||
|
|||
Continue reading. 👇🤓 |
|||
|
|||
/// |
|||
|
|||
## Why Virtual Environments |
|||
|
|||
To work with FastAPI you need to install <a href="https://www.python.org/" class="external-link" target="_blank">Python</a>. |
|||
|
|||
After that, you would need to **install** FastAPI and any other **packages** you want to use. |
|||
|
|||
To install packages you would normally use the `pip` command that comes with Python (or similar alternatives). |
|||
|
|||
Nevertheless, if you just use `pip` directly, the packages would be installed in your **global Python environment** (the global installation of Python). |
|||
|
|||
### The Problem |
|||
|
|||
So, what's the problem with installing packages in the global Python environment? |
|||
|
|||
At some point, you will probably end up writing many different programs that depend on **different packages**. And some of these projects you work on will depend on **different versions** of the same package. 😱 |
|||
|
|||
For example, you could create a project called `philosophers-stone`, this program depends on another package called **`harry`, using the version `1`**. So, you need to install `harry`. |
|||
|
|||
```mermaid |
|||
flowchart LR |
|||
stone(philosophers-stone) -->|requires| harry-1[harry v1] |
|||
``` |
|||
|
|||
Then, at some point later, you create another project called `prisoner-of-azkaban`, and this project also depends on `harry`, but this project needs **`harry` version `3`**. |
|||
|
|||
```mermaid |
|||
flowchart LR |
|||
azkaban(prisoner-of-azkaban) --> |requires| harry-3[harry v3] |
|||
``` |
|||
|
|||
But now the problem is, if you install the packages globally (in the global environment) instead of in a local **virtual environment**, you will have to choose which version of `harry` to install. |
|||
|
|||
If you want to run `philosophers-stone` you will need to first install `harry` version `1`, for example with: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ pip install "harry==1" |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
And then you would end up with `harry` version `1` installed in your global Python environment. |
|||
|
|||
```mermaid |
|||
flowchart LR |
|||
subgraph global[global env] |
|||
harry-1[harry v1] |
|||
end |
|||
subgraph stone-project[philosophers-stone project] |
|||
stone(philosophers-stone) -->|requires| harry-1 |
|||
end |
|||
``` |
|||
|
|||
But then if you want to run `prisoner-of-azkaban`, you will need to uninstall `harry` version `1` and install `harry` version `3` (or just installing version `3` would automatically uninstall version `1`). |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ pip install "harry==3" |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
And then you would end up with `harry` version `3` installed in your global Python environment. |
|||
|
|||
And if you try to run `philosophers-stone` again, there's a chance it would **not work** because it needs `harry` version `1`. |
|||
|
|||
```mermaid |
|||
flowchart LR |
|||
subgraph global[global env] |
|||
harry-1[<strike>harry v1</strike>] |
|||
style harry-1 fill:#ccc,stroke-dasharray: 5 5 |
|||
harry-3[harry v3] |
|||
end |
|||
subgraph stone-project[philosophers-stone project] |
|||
stone(philosophers-stone) -.-x|⛔️| harry-1 |
|||
end |
|||
subgraph azkaban-project[prisoner-of-azkaban project] |
|||
azkaban(prisoner-of-azkaban) --> |requires| harry-3 |
|||
end |
|||
``` |
|||
|
|||
/// tip |
|||
|
|||
It's very common in Python packages to try the best to **avoid breaking changes** in **new versions**, but it's better to be safe, and install newer versions intentionally and when you can run the tests to check everything is working correctly. |
|||
|
|||
/// |
|||
|
|||
Now, imagine that with **many** other **packages** that all your **projects depend on**. That's very difficult to manage. And you would probably end up running some projects with some **incompatible versions** of the packages, and not knowing why something isn't working. |
|||
|
|||
Also, depending on your operating system (e.g. Linux, Windows, macOS), it could have come with Python already installed. And in that case it probably had some packages pre-installed with some specific versions **needed by your system**. If you install packages in the global Python environment, you could end up **breaking** some of the programs that came with your operating system. |
|||
|
|||
## Where are Packages Installed |
|||
|
|||
When you install Python, it creates some directories with some files in your computer. |
|||
|
|||
Some of these directories are the ones in charge of having all the packages you install. |
|||
|
|||
When you run: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
// Don't run this now, it's just an example 🤓 |
|||
$ pip install "fastapi[standard]" |
|||
---> 100% |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
That will download a compressed file with the FastAPI code, normally from <a href="https://pypi.org/project/fastapi/" class="external-link" target="_blank">PyPI</a>. |
|||
|
|||
It will also **download** files for other packages that FastAPI depends on. |
|||
|
|||
Then it will **extract** all those files and put them in a directory in your computer. |
|||
|
|||
By default, it will put those files downloaded and extracted in the directory that comes with your Python installation, that's the **global environment**. |
|||
|
|||
## What are Virtual Environments |
|||
|
|||
The solution to the problems of having all the packages in the global environment is to use a **virtual environment for each project** you work on. |
|||
|
|||
A virtual environment is a **directory**, very similar to the global one, where you can install the packages for a project. |
|||
|
|||
This way, each project will have it's own virtual environment (`.venv` directory) with its own packages. |
|||
|
|||
```mermaid |
|||
flowchart TB |
|||
subgraph stone-project[philosophers-stone project] |
|||
stone(philosophers-stone) --->|requires| harry-1 |
|||
subgraph venv1[.venv] |
|||
harry-1[harry v1] |
|||
end |
|||
end |
|||
subgraph azkaban-project[prisoner-of-azkaban project] |
|||
azkaban(prisoner-of-azkaban) --->|requires| harry-3 |
|||
subgraph venv2[.venv] |
|||
harry-3[harry v3] |
|||
end |
|||
end |
|||
stone-project ~~~ azkaban-project |
|||
``` |
|||
|
|||
## What Does Activating a Virtual Environment Mean |
|||
|
|||
When you activate a virtual environment, for example with: |
|||
|
|||
//// tab | Linux, macOS |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ source .venv/bin/activate |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows PowerShell |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ .venv\Scripts\Activate.ps1 |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows Bash |
|||
|
|||
Or if you use Bash for Windows (e.g. <a href="https://gitforwindows.org/" class="external-link" target="_blank">Git Bash</a>): |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ source .venv/Scripts/activate |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
That command will create or modify some [environment variables](environment-variables.md){.internal-link target=_blank} that will be available for the next commands. |
|||
|
|||
One of those variables is the `PATH` variable. |
|||
|
|||
/// tip |
|||
|
|||
You can learn more about the `PATH` environment variable in the [Environment Variables](environment-variables.md#path-environment-variable){.internal-link target=_blank} section. |
|||
|
|||
/// |
|||
|
|||
Activating a virtual environment adds its path `.venv/bin` (on Linux and macOS) or `.venv\Scripts` (on Windows) to the `PATH` environment variable. |
|||
|
|||
Let's say that before activating the environment, the `PATH` variable looked like this: |
|||
|
|||
//// tab | Linux, macOS |
|||
|
|||
```plaintext |
|||
/usr/bin:/bin:/usr/sbin:/sbin |
|||
``` |
|||
|
|||
That means that the system would look for programs in: |
|||
|
|||
* `/usr/bin` |
|||
* `/bin` |
|||
* `/usr/sbin` |
|||
* `/sbin` |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows |
|||
|
|||
```plaintext |
|||
C:\Windows\System32 |
|||
``` |
|||
|
|||
That means that the system would look for programs in: |
|||
|
|||
* `C:\Windows\System32` |
|||
|
|||
//// |
|||
|
|||
After activating the virtual environment, the `PATH` variable would look something like this: |
|||
|
|||
//// tab | Linux, macOS |
|||
|
|||
```plaintext |
|||
/home/user/code/awesome-project/.venv/bin:/usr/bin:/bin:/usr/sbin:/sbin |
|||
``` |
|||
|
|||
That means that the system will now start looking first look for programs in: |
|||
|
|||
```plaintext |
|||
/home/user/code/awesome-project/.venv/bin |
|||
``` |
|||
|
|||
before looking in the other directories. |
|||
|
|||
So, when you type `python` in the terminal, the system will find the Python program in |
|||
|
|||
```plaintext |
|||
/home/user/code/awesome-project/.venv/bin/python |
|||
``` |
|||
|
|||
and use that one. |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows |
|||
|
|||
```plaintext |
|||
C:\Users\user\code\awesome-project\.venv\Scripts;C:\Windows\System32 |
|||
``` |
|||
|
|||
That means that the system will now start looking first look for programs in: |
|||
|
|||
```plaintext |
|||
C:\Users\user\code\awesome-project\.venv\Scripts |
|||
``` |
|||
|
|||
before looking in the other directories. |
|||
|
|||
So, when you type `python` in the terminal, the system will find the Python program in |
|||
|
|||
```plaintext |
|||
C:\Users\user\code\awesome-project\.venv\Scripts\python |
|||
``` |
|||
|
|||
and use that one. |
|||
|
|||
//// |
|||
|
|||
An important detail is that it will put the virtual environment path at the **beginning** of the `PATH` variable. The system will find it **before** finding any other Python available. This way, when you run `python`, it will use the Python **from the virtual environment** instead of any other `python` (for example, a `python` from a global environment). |
|||
|
|||
Activating a virtual environment also changes a couple of other things, but this is one of the most important things it does. |
|||
|
|||
## Checking a Virtual Environment |
|||
|
|||
When you check if a virtual environment is active, for example with: |
|||
|
|||
//// tab | Linux, macOS, Windows Bash |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ which python |
|||
|
|||
/home/user/code/awesome-project/.venv/bin/python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
//// tab | Windows PowerShell |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ Get-Command python |
|||
|
|||
C:\Users\user\code\awesome-project\.venv\Scripts\python |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
//// |
|||
|
|||
That means that the `python` program that will be used is the one **in the virtual environment**. |
|||
|
|||
you use `which` in Linux and macOS and `Get-Command` in Windows PowerShell. |
|||
|
|||
The way that command works is that it will go and check in the `PATH` environment variable, going through **each path in order**, looking for the program called `python`. Once it finds it, it will **show you the path** to that program. |
|||
|
|||
The most important part is that when you call `python`, that is the exact "`python`" that will be executed. |
|||
|
|||
So, you can confirm if you are in the correct virtual environment. |
|||
|
|||
/// tip |
|||
|
|||
It's easy to activate one virtual environment, get one Python, and then **go to another project**. |
|||
|
|||
And the second project **wouldn't work** because you are using the **incorrect Python**, from a virtual environment for another project. |
|||
|
|||
It's useful being able to check what `python` is being used. 🤓 |
|||
|
|||
/// |
|||
|
|||
## Why Deactivate a Virtual Environment |
|||
|
|||
For example, you could be working on a project `philosophers-stone`, **activate that virtual environment**, install packages and work with that environment. |
|||
|
|||
And then you want to work on **another project** `prisoner-of-azkaban`. |
|||
|
|||
You go to that project: |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ cd ~/code/prisoner-of-azkaban |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
If you don't deactivate the virtual environment for `philosophers-stone`, when you run `python` in the terminal, it will try to use the Python from `philosophers-stone`. |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ cd ~/code/prisoner-of-azkaban |
|||
|
|||
$ python main.py |
|||
|
|||
// Error importing sirius, it's not installed 😱 |
|||
Traceback (most recent call last): |
|||
File "main.py", line 1, in <module> |
|||
import sirius |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
But if you deactivate the virtual environment and activate the new one for `prisoner-of-askaban` then when you run `python` it will use the Python from the virtual environment in `prisoner-of-azkaban`. |
|||
|
|||
<div class="termy"> |
|||
|
|||
```console |
|||
$ cd ~/code/prisoner-of-azkaban |
|||
|
|||
// You don't need to be in the old directory to deactivate, you can do it wherever you are, even after going to the other project 😎 |
|||
$ deactivate |
|||
|
|||
// Activate the virtual environment in prisoner-of-azkaban/.venv 🚀 |
|||
$ source .venv/bin/activate |
|||
|
|||
// Now when you run python, it will find the package sirius installed in this virtual environment ✨ |
|||
$ python main.py |
|||
|
|||
I solemnly swear 🐺 |
|||
``` |
|||
|
|||
</div> |
|||
|
|||
## Alternatives |
|||
|
|||
This is a simple guide to get you started and teach you how everything works **underneath**. |
|||
|
|||
There are many **alternatives** to managing virtual environments, package dependencies (requirements), projects. |
|||
|
|||
Once you are ready and want to use a tool to **manage the entire project**, packages dependencies, virtual environments, etc. I would suggest you try <a href="https://github.com/astral-sh/uv" class="external-link" target="_blank">uv</a>. |
|||
|
|||
`uv` can do a lot of things, it can: |
|||
|
|||
* **Install Python** for you, including different versions |
|||
* Manage the **virtual environment** for your projects |
|||
* Install **packages** |
|||
* Manage package **dependencies and versions** for your project |
|||
* Make sure you have an **exact** set of packages and versions to install, including their dependencies, so that you can be sure that you can run your project in production exactly the same as in your computer while developing, this is called **locking** |
|||
* And many other things |
|||
|
|||
## Conclusion |
|||
|
|||
If you read and understood all this, now **you know much more** about virtual environments than many developers out there. 🤓 |
|||
|
|||
Knowing these details will most probably be useful in a future time when you are debugging something that seems complex, but you will know **how it all works underneath**. 😎 |
|||
@ -1,228 +0,0 @@ |
|||
# Copyright (c) 2016-2023 Martin Donath <[email protected]> |
|||
|
|||
# Permission is hereby granted, free of charge, to any person obtaining a copy |
|||
# of this software and associated documentation files (the "Software"), to |
|||
# deal in the Software without restriction, including without limitation the |
|||
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
|||
# sell copies of the Software, and to permit persons to whom the Software is |
|||
# furnished to do so, subject to the following conditions: |
|||
|
|||
# The above copyright notice and this permission notice shall be included in |
|||
# all copies or substantial portions of the Software. |
|||
|
|||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE |
|||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
|||
# IN THE SOFTWARE. |
|||
|
|||
# ----------------------------------------------------------------------------- |
|||
# Configuration |
|||
# ----------------------------------------------------------------------------- |
|||
|
|||
# The same default card with a a configurable logo |
|||
|
|||
# Definitions |
|||
definitions: |
|||
|
|||
# Background image |
|||
- &background_image >- |
|||
{{ layout.background_image or "" }} |
|||
|
|||
# Background color (default: indigo) |
|||
- &background_color >- |
|||
{%- if layout.background_color -%} |
|||
{{ layout.background_color }} |
|||
{%- else -%} |
|||
{%- set palette = config.theme.palette or {} -%} |
|||
{%- if not palette is mapping -%} |
|||
{%- set palette = palette | first -%} |
|||
{%- endif -%} |
|||
{%- set primary = palette.get("primary", "indigo") -%} |
|||
{%- set primary = primary.replace(" ", "-") -%} |
|||
{{ { |
|||
"red": "#ef5552", |
|||
"pink": "#e92063", |
|||
"purple": "#ab47bd", |
|||
"deep-purple": "#7e56c2", |
|||
"indigo": "#4051b5", |
|||
"blue": "#2094f3", |
|||
"light-blue": "#02a6f2", |
|||
"cyan": "#00bdd6", |
|||
"teal": "#009485", |
|||
"green": "#4cae4f", |
|||
"light-green": "#8bc34b", |
|||
"lime": "#cbdc38", |
|||
"yellow": "#ffec3d", |
|||
"amber": "#ffc105", |
|||
"orange": "#ffa724", |
|||
"deep-orange": "#ff6e42", |
|||
"brown": "#795649", |
|||
"grey": "#757575", |
|||
"blue-grey": "#546d78", |
|||
"black": "#000000", |
|||
"white": "#ffffff" |
|||
}[primary] or "#4051b5" }} |
|||
{%- endif -%} |
|||
|
|||
# Text color (default: white) |
|||
- &color >- |
|||
{%- if layout.color -%} |
|||
{{ layout.color }} |
|||
{%- else -%} |
|||
{%- set palette = config.theme.palette or {} -%} |
|||
{%- if not palette is mapping -%} |
|||
{%- set palette = palette | first -%} |
|||
{%- endif -%} |
|||
{%- set primary = palette.get("primary", "indigo") -%} |
|||
{%- set primary = primary.replace(" ", "-") -%} |
|||
{{ { |
|||
"red": "#ffffff", |
|||
"pink": "#ffffff", |
|||
"purple": "#ffffff", |
|||
"deep-purple": "#ffffff", |
|||
"indigo": "#ffffff", |
|||
"blue": "#ffffff", |
|||
"light-blue": "#ffffff", |
|||
"cyan": "#ffffff", |
|||
"teal": "#ffffff", |
|||
"green": "#ffffff", |
|||
"light-green": "#ffffff", |
|||
"lime": "#000000", |
|||
"yellow": "#000000", |
|||
"amber": "#000000", |
|||
"orange": "#000000", |
|||
"deep-orange": "#ffffff", |
|||
"brown": "#ffffff", |
|||
"grey": "#ffffff", |
|||
"blue-grey": "#ffffff", |
|||
"black": "#ffffff", |
|||
"white": "#000000" |
|||
}[primary] or "#ffffff" }} |
|||
{%- endif -%} |
|||
|
|||
# Font family (default: Roboto) |
|||
- &font_family >- |
|||
{%- if layout.font_family -%} |
|||
{{ layout.font_family }} |
|||
{%- elif config.theme.font != false -%} |
|||
{{ config.theme.font.get("text", "Roboto") }} |
|||
{%- else -%} |
|||
Roboto |
|||
{%- endif -%} |
|||
|
|||
# Site name |
|||
- &site_name >- |
|||
{{ config.site_name }} |
|||
|
|||
# Page title |
|||
- &page_title >- |
|||
{{ page.meta.get("title", page.title) }} |
|||
|
|||
# Page title with site name |
|||
- &page_title_with_site_name >- |
|||
{%- if not page.is_homepage -%} |
|||
{{ page.meta.get("title", page.title) }} - {{ config.site_name }} |
|||
{%- else -%} |
|||
{{ page.meta.get("title", page.title) }} |
|||
{%- endif -%} |
|||
|
|||
# Page description |
|||
- &page_description >- |
|||
{{ page.meta.get("description", config.site_description) or "" }} |
|||
|
|||
|
|||
# Start of custom modified logic |
|||
# Logo |
|||
- &logo >- |
|||
{%- if layout.logo -%} |
|||
{{ layout.logo }} |
|||
{%- elif config.theme.logo -%} |
|||
{{ config.docs_dir }}/{{ config.theme.logo }} |
|||
{%- endif -%} |
|||
# End of custom modified logic |
|||
|
|||
# Logo (icon) |
|||
- &logo_icon >- |
|||
{{ config.theme.icon.logo or "" }} |
|||
|
|||
# Meta tags |
|||
tags: |
|||
|
|||
# Open Graph |
|||
og:type: website |
|||
og:title: *page_title_with_site_name |
|||
og:description: *page_description |
|||
og:image: "{{ image.url }}" |
|||
og:image:type: "{{ image.type }}" |
|||
og:image:width: "{{ image.width }}" |
|||
og:image:height: "{{ image.height }}" |
|||
og:url: "{{ page.canonical_url }}" |
|||
|
|||
# Twitter |
|||
twitter:card: summary_large_image |
|||
twitter.title: *page_title_with_site_name |
|||
twitter:description: *page_description |
|||
twitter:image: "{{ image.url }}" |
|||
|
|||
# ----------------------------------------------------------------------------- |
|||
# Specification |
|||
# ----------------------------------------------------------------------------- |
|||
|
|||
# Card size and layers |
|||
size: { width: 1200, height: 630 } |
|||
layers: |
|||
|
|||
# Background |
|||
- background: |
|||
image: *background_image |
|||
color: *background_color |
|||
|
|||
# Logo |
|||
- size: { width: 144, height: 144 } |
|||
offset: { x: 992, y: 64 } |
|||
background: |
|||
image: *logo |
|||
icon: |
|||
value: *logo_icon |
|||
color: *color |
|||
|
|||
# Site name |
|||
- size: { width: 832, height: 42 } |
|||
offset: { x: 64, y: 64 } |
|||
typography: |
|||
content: *site_name |
|||
color: *color |
|||
font: |
|||
family: *font_family |
|||
style: Bold |
|||
|
|||
# Page title |
|||
- size: { width: 832, height: 310 } |
|||
offset: { x: 62, y: 160 } |
|||
typography: |
|||
content: *page_title |
|||
align: start |
|||
color: *color |
|||
line: |
|||
amount: 3 |
|||
height: 1.25 |
|||
font: |
|||
family: *font_family |
|||
style: Bold |
|||
|
|||
# Page description |
|||
- size: { width: 832, height: 64 } |
|||
offset: { x: 64, y: 512 } |
|||
typography: |
|||
content: *page_description |
|||
align: start |
|||
color: *color |
|||
line: |
|||
amount: 2 |
|||
height: 1.5 |
|||
font: |
|||
family: *font_family |
|||
style: Regular |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue