Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a collection of example scripts for end users #65

Open
1 of 3 tasks
zstumgoren opened this issue Dec 18, 2020 · 0 comments
Open
1 of 3 tasks

Create a collection of example scripts for end users #65

zstumgoren opened this issue Dec 18, 2020 · 0 comments
Labels
help wanted Extra attention is needed

Comments

@zstumgoren
Copy link
Member

zstumgoren commented Dec 18, 2020

In addition to documenting code usage, create a collection of example scripts to help end users get started with code usage.

  • examples/README.md with quick overview reminding users how to install via pip and run the code. Should mention where to obtain the list of CivicPlus sites.
  • basic example showing how to download file metadata for a date range from one site
  • How to download file assets from one site with a date range
@zstumgoren zstumgoren added question Further information is requested help wanted Extra attention is needed labels Dec 18, 2020
@zstumgoren zstumgoren changed the title Create a collection of example scripts for end users? Create a collection of example scripts for end users Dec 18, 2020
@zstumgoren zstumgoren removed the question Further information is requested label Dec 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant