drivendataorg/cloudpathlib

Docs page for vignettes or scenarios

Offen

#90 geöffnet am 04.10.2020

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (87 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (624 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Would be cool to have snippets page that covers some very common tasks. Here are a few off the top of my head:

  • recursively get all files in a directory (i.e., with glob)
  • list directory, but not recursively
  • write a new file to the cloud
  • make a persistent local cache
  • open a file for read/write
  • passing an instantiated client rather than using the default

Contributor Guide

Research-Richtung
Erstelle Code Snippets für jede Aufgabe im Issue Text unter Verwendung von cloudpathlib.Path Methoden (z.B. .glob(), .iterdir(), .write bytes()) und füge Erklärungen hinzu.
Tech Stack
python
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Pythoncloudpathlib
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90