drivendataorg/cloudpathlib

Docs page for vignettes or scenarios

Open

#90 opened on Oct 4, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (87 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (624 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Create code snippets for each task in the issue body using cloudpathlib.Path methods (e.g., .glob(), .iterdir(), .write bytes(), etc.) and add explanations.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythoncloudpathlib
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90