BasicAuth CouchDB Example

Offen
  • Stimmt etwas nicht?
#136 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
30/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Beginne mit der Durchsicht der vorhandenen CouchDB-Dokumentation sowie der im Issue gezeigten Einstiegspunkte CouchdbResource und restkit.BasicAuth. Füge an der geeigneten Stelle in der Dokumentation ein offizielles CouchDB-Beispiel für BasicAuth hinzu und überprüfe, dass die dokumentierte Verwendung korrekt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

I looked around before posting this, but if I missed it in the channel, group, or another ticket, I apologise.

I noticed there was no example for authentication (cf. BasicAuth) against CouchDB. I was thinking it might be nice to put an official example of using BasicAuth up in the docs. I assume what I worked out is right, but I'm filing this here because there may already be a cleaner way, or this may be less than efficient for some reason. (And this probably belongs in docs, not on the wiki, but I'm happy to put it there if it's a better idea)

import couchdbkit
from restkit import BasicAuth

uri = "http://127.0.0.1:5984/"
username = "CouchDBUsername"
password = "CouchDBPassword"

CouchDBAuth = couchdbkit.resource.CouchdbResource(filters=[BasicAuth(username, password)])
CouchDBServer = couchdbkit.Server(uri, resource_instance=CouchDBAuth)

As the function is already in restkit, I assume there's no reason to configure helpers/wrappers for CouchDB to do this, and I also assume that OAuth is similar (though I wouldn't know and can't test, I only use BasicAuth for CouchDB at the moment).

Vorherrschende Sprache
Python
Sterne
261
Forks
90
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus benoitc/couchdbkit

Alle Issues in benoitc/couchdbkit

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.