öffentliche Büro Dateien
IT-Beratung & Service S.G.

Bei der Auswahl eines Namens für ein Python-Paket gibt es einige Regeln und Best Practices,
die Sie beachten sollten, um sicherzustellen, dass Ihr Paketname gültig und konform mit den
Standards des Python Package Index (PyPI) ist. Hier sind die wichtigsten Richtlinien und
Empfehlungen:
Namensregeln für Python-Pakete:
1. **Nur Kleinbuchstaben**: Paketnamen sollten nur Kleinbuchstaben enthalten.
Großbuchstaben sind nicht erlaubt.
- **Richtig**: `mypackage`
- **Falsch**: `MyPackage`
2. **Keine Sonderzeichen**: Verwenden Sie nur Buchstaben, Zahlen und Unterstriche (_).
Bindestriche (-) sind erlaubt, aber Leerzeichen und andere Sonderzeichen sind nicht zulässig.
- **Richtig**: `my_package`, `my-package`
- **Falsch**: `my package`, `my@package`
3. **Nicht mit einer Zahl beginnen**: Paketnamen sollten nicht mit einer Zahl beginnen.
- **Richtig**: `package1`
- **Falsch**: `1package`
4. **Eindeutigkeit und Vermeidung von Konflikten**: Wählen Sie einen eindeutigen Namen, der
noch nicht auf PyPI existiert, um Namenskonflikte zu vermeiden. Sie können auf der
[PyPI-Website](https://pypi.org/) nach verfügbaren Namen suchen.
5. **Länge des Namens**: Obwohl es keine harte Grenze gibt, sollten Paketnamen nicht zu lang
sein, um die Lesbarkeit und Handhabung zu erleichtern.
6. **Beschreibung des Inhalts**: Wählen Sie einen Namen, der den Inhalt oder Zweck des
Pakets gut beschreibt. Dies hilft anderen Entwicklern, den Nutzen Ihres Pakets besser zu
verstehen.
Beispiele für gültige Python-Paketnamen:
- `requests`
- `numpy`
- `beautifulsoup4`
- `pandas`
- `flask`
Hier ist ein kurzes Beispiel, wie Sie ein neues Python-Paket initialisieren könnten:mkdir my_package
cd my_package
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip setuptools wheel
Erstellen Sie dann eine `setup.py`-Datei für Ihr Paket:
—---------
from setuptools import setup, find_packages
setup(
name='my_package',
version='0.1.0',
packages=find_packages(),
install_requires=[],
)
—-------
Diese Richtlinien helfen Ihnen dabei, ein gut strukturiertes und leicht zugängliches Python-Paket
zu erstellen.my_project/
├── README.md
├── setup.py
├── requirements.txt
├── .gitignore
├── LICENSE
├── my_project/
│ ├── __init__.py
│ ├── main_module.py
│ ├── module1.py
│ ├── module2.py
│ └── subpackage/
│
├── __init__.py
│
└── submodule.py
├── tests/
│ ├── __init__.py
│ ├── test_main_module.py
│ ├── test_module1.py
│ └── test_module2.py
└── docs/
└── index.md