Web-Schnittstelle

Eine Web-Schnittstelle wird über einen einfachen Speicher implementiert. Die Schnittstelle ist über die Domain python.org verfügbar, entweder direkt oder als packages.python.org.

Der Speicher hat Spalten für alle Metadatenfelder. Das (name, version)-Doppel wird als Eindeutigkeitsschlüssel verwendet. Zusätzliche Übermittlungen für ein vorhandenes (name, version) führen zu einer Update-Operation.

Die Web-Schnittstelle implementiert die folgenden Kommandos/Schnittstellen

index

Listet bekannte Pakete auf, optional gefiltert. Eine zusätzliche HTML-Seite, search, präsentiert dem Benutzer ein Formular, das zur Anpassung der Indexansicht verwendet wird. Der Index wird eine Browsing-Oberfläche enthalten, ähnlich der im Abschnitt 4.3 des Trove-Schnittstellendesigns präsentierten. Die Ergebnisse werden paginiert, alphabetisch sortiert und zeigen nur die neueste Version. Die Information über die neueste Version wird mithilfe der Distutils LooseVersion-Klasse ermittelt.

display

Zeigt Informationen über das Paket an. Alle Felder werden als Klartext angezeigt. Das Feld "url" (oder "home_page") ist verlinkt.

submit

Akzeptiert eine POST-Übermittlung von Metadaten über ein Paket. Die Felder "name" und "version" sind obligatorisch, da sie einen Eintrag im Index eindeutig identifizieren. Submit ermittelt automatisch, ob ein neuer Eintrag erstellt oder ein bestehender aktualisiert werden soll. Die Metadaten werden, wo angebracht, auf Korrektheit geprüft – insbesondere werden die Trove-Diskriminatoren mit dem zulässigen Satz verglichen. Ein Update aktualisiert alle Informationen über das Paket auf Basis der neu übermittelten Informationen.

Es wird auch ein submit/edit-Formular geben, das manuelle Übermittlung und Aktualisierung für diejenigen ermöglicht, die Distutils nicht verwenden.

submit_pkg_info

Akzeptiert eine POST-Übermittlung einer PKG-INFO-Datei und führt dieselbe Funktion wie die submit-Schnittstelle aus.

user

Registriert einen neuen Benutzer beim Index. Benötigt Benutzername, Passwort und E-Mail-Adresse. Passwörter werden in der Indexdatenbank als SHA-Hashes gespeichert. Wenn der Benutzername bereits in der Datenbank existiert

1. Wenn eine gültige HTTP Basic-Authentifizierung bereitgestellt wird, werden das Passwort und die E-Mail-Adresse mit den Übermittlungsinformationen aktualisiert, oder
2. Wenn keine gültige Authentifizierung bereitgestellt wird, wird der Benutzer informiert, dass der Login bereits vergeben ist.

Die Registrierung wird ein dreistufiger Prozess sein, der Folgendes beinhaltet:

1. Benutzerübermittlung von Details über das Distutils register-Kommando oder über das Web,
2. Index-Server sendet eine E-Mail an die E-Mail-Adresse des Benutzers mit einer URL, die besucht werden muss, um die Registrierung mit einem zufälligen Einmal-Schlüssel zu bestätigen, und
3. Benutzer besucht die URL mit dem Schlüssel und bestätigt die Registrierung.

roles

Eine Schnittstelle zum Ändern von Benutzerrollen-Zuweisungen.

password_reset

Unter Verwendung der bereitgestellten E-Mail-Adresse als Schlüssel wird das Passwort eines Benutzers zurückgesetzt und eine E-Mail mit dem neuen Passwort an den Benutzer gesendet.

Das submit-Kommando erfordert HTTP Basic-Authentifizierung, vorzugsweise über eine HTTPS-Verbindung.

Die Server-Schnittstelle wird Erfolg oder Misserfolg der Kommandos über eine Teilmenge der Standard-HTTP-Antwortcodes anzeigen

Benutzerrollen

Drei Benutzerrollen können Benutzern zugewiesen werden

Besitzer

Besitzt einen Paketnamen, darf die Rolle des Warteschreibers für diesen Namen zuweisen. Der erste Benutzer, der Informationen über ein Paket registriert, gilt als Besitzer des Paketnamens. Der Admin-Benutzer kann dies bei Bedarf ändern. Darf Updates für den Paketnamen einreichen.

Warteschreiber

Kann Informationen für einen bestimmten Paketnamen einreichen und aktualisieren.

Administrator

Kann die Rolle des Besitzers zuweisen und Benutzerdetails bearbeiten. Nicht spezifisch für einen Paketnamen.

Index-Speicherung (Schema)

Der Index wird in einer Reihe von relationalen Datenbanktabellen gespeichert

packages

Listet Paketnamen auf und speichert Metadaten auf Paketebene (derzeit nur die stabile Release-Version)

releases

Jedes Paket hat einen Eintrag in releases für jede Version des Pakets, die veröffentlicht wurde. Eine Zeile enthält den Großteil der Informationen, die in der PKG-INFO-Datei des Pakets enthalten sind. Es gibt eine Zeile für jedes Paket (name, version).

trove_discriminators

Listet den Trove-Diskriminatortext auf und weist jedem eine eindeutige ID zu.

release_discriminators

Jeder Eintrag ordnet ein Paket (name, version) einer discriminator_id zu. Wir ordnen Releases statt Paketen zu, da die Menge der Diskriminatoren zwischen Releases variieren kann.

journals

Enthält Informationen über Änderungen an Paketinformationen im Index. Änderungen an den Tabellen packages, releases, roles und release_discriminators werden hier nach Paketname und version aufgelistet, wenn die Änderung release-spezifisch ist.

users

Enthält unsere Benutzerdatenbank – Benutzername, E-Mail-Adresse und Passwort.

roles

Ordnet user_name und role_name einem package_name zu.

Eine zusätzliche Tabelle, rego_otk, enthält die Einmal-Schlüssel, die während der Registrierung generiert werden, und ist für den Index selbst nicht von Interesse.

Distutils register Kommando

Ein zusätzliches Distutils-Kommando, register, wird implementiert, das die Paketmetadaten an den zentralen Index sendet. Das register-Kommando behandelt die Benutzerregistrierung automatisch; dem Benutzer werden drei Optionen angeboten

1. Paketinformationen einloggen und übermitteln
2. als neuer Packager registrieren
3. Passwort-Erinnerungs-E-Mail senden

Auf Systemen, bei denen die Umgebungsvariable $HOME gesetzt ist, wird der Benutzer beim Beenden aufgefordert, seinen Benutzernamen/Passwort in einer Datei in seinem $HOME-Verzeichnis unter dem Namen .pypirc zu speichern.

Benachrichtigungen über Änderungen an einem Paketeintrag werden an alle Benutzer gesendet, die Informationen über das Paket übermittelt haben. Das heißt, der ursprüngliche Übermittler und alle nachfolgenden Aktualisierer.

Das register-Kommando wird eine Option --verify enthalten, die eine Testübermittlung an den Index durchführt, ohne die Daten tatsächlich zu committen. Der Index führt wie üblich seine Überprüfung der Übermittlung durch und meldet alle Fehler, die er bei einer normalen Übermittlung gemeldet hätte. Dies ist nützlich zur Überprüfung der Korrektheit von Trove-Diskriminatoren.

Distutils Trove-Klassifizierung

Das Trove-Konzept der Diskriminierung wird dem Metadatensatz hinzugefügt, der Paketautoren über das neue Attribut "classifiers" zur Verfügung steht. Die Liste der Klassifikatoren wird über das Web verfügbar sein und wie folgt zum Paket hinzugefügt

setup(
    name = "roundup",
    version = __version__,
    classifiers = [
        'Development Status :: 4 - Beta',
        'Environment :: Console',
        'Environment :: Web Environment',
        'Intended Audience :: End Users/Desktop',
        'Intended Audience :: Developers',
        'Intended Audience :: System Administrators',
        'License :: OSI Approved :: Python Software Foundation License',
        'Operating System :: MacOS :: MacOS X',
        'Operating System :: Microsoft :: Windows',
        'Operating System :: POSIX',
        'Programming Language :: Python',
        'Topic :: Communications :: Email',
        'Topic :: Office/Business',
        'Topic :: Software Development :: Bug Tracking',
    ],
    url = 'http://sourceforge.net/projects/roundup/',
    ...
)

Es wurde entschieden, dass Strings für die Klassifizierungseinträge verwendet werden, aufgrund der tiefen Verschachtelung, die bei einer formelleren Python-Struktur auftreten würde.

Die ursprüngliche Trove-Spezifikation, dass Klassifizierungs-Namensräume durch Schrägstriche („/“) getrennt werden, kollidiert leider mit vielen Namen, die Schrägstriche enthalten (z. B. „OS/2“). Die Doppelpunktlösung („ :: “), die von SourceForge und FreshMeat implementiert wurde, umgeht diese Einschränkung.

Die Liste der Klassifizierungswerte im Modulindex wurde von FreshMeat und SourceForge (mit deren Erlaubnis) übernommen. Diese Liste wird sowohl über die Web-Schnittstelle als auch über die Option --list-classifiers des register-Kommandos als Textliste zur Verfügung gestellt, die dann in die setup.py-Datei kopiert werden kann. Die Option --verify des register-Kommandos prüft die Klassifizierungswerte gegen die Liste des Servers.

Leider ist die Hinzufügung der Eigenschaft "classifiers" nicht abwärtskompatibel. Eine setup.py-Datei, die sie verwendet, funktioniert nicht unter Python 2.1.3. Es wird gehofft, dass eine Bugfix-Version von Python 2.2 (wahrscheinlich 2.2.3) die Argumentprüfung des setup()-Kommandos lockert, um neue Schlüsselwörter zuzulassen, auch wenn sie nicht tatsächlich verwendet werden. Es ist vorzuziehen, dass eine Warnung ausgegeben wird, anstatt eines schwerwiegenden Fehlers. Die Verwendung des neuen Schlüsselworts sollte in Situationen, in denen das Paket als kompatibel mit Python-Versionen früher als 2.2.3 oder 2.3 beworben wird, vermieden werden.

In der PKG-INFO erscheinen die Klassifizierungslisteinträge als einzelne Classifier:-Einträge

Name: roundup
Version: 0.5.2
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console (Text Based)
            .
            .
Classifier: Topic :: Software Development :: Bug Tracking
Url: http://sourceforge.net/projects/roundup/