PEDP scripts

This is not your normal GitHub repository.

Instead of containing a single project with a coherent structure, it is intended to allow any coders who are:

• archiving data sets for the Public Environmental Data Partners (https://screening-tools.com) OR
• building utilities for audit/maintenance of archive spaces like Dataverse or Zenodo to upload their working scripts both for safe-keeping and for others to reference and possibly build upon.

Eventually, the code in this repo may evolve into more coherent structure of tools. For now, however,

• small scraping/archiving code should simply be added in folders named after the acronym of the agency, under /DataArchiveProjects , along with a readme file for the project. If there are multiple projects for a specific agency folder, subset folders should be added for clarity.
• auditing and other scripts should be added under /utilities .

Adding code

If you have built code in the course of your work on a PEDP project, we strongly encourage you to share it here. It does not need to be perfect or even polished (read some of the existing code if you need to be convinced of that ;-). If code was useful to you, it may save another contributor or your future self some time and trouble to be able to find it here as a starting point for another project.

In general, follow the steps in the Contributing guide, specifically for making code changes using Pull Requests. In addition, here are some notes specific to the folders in this repo.

DataArchiveProjects

If you add code here, please:

• create a folder for your code, use your own best judgement for a folder name. Standard practice is to use the agency acronym. If a folder for the agency you're working on already exists, create a subfolder within that.
• along with any working code, add a readme.txt file that documents:
  • the URL of the primary web page you were archiving
  • the URL of the online repository location where your archived data was stored
  • any other notes you made about the code you are archiving
  • (optional) a url to the google drive metadata for the archived dataset

(Note also that, while it is not currently required, it has become a common and recommended practice to bundle the code you used for an archving project into a zip file that is archived with the data.)

utilities

For code that is not associated with a specific archiving project, please add it here. You're welcome to add code to any existing folder or, if none apply, to create a folder of your own. If you add code to an existing folder, please update the readme.txt there. If you create a new folder, please include a readme.txt file

---

git process from your local development environment

Please install git on your machine if you don't already use it. You can fork (copy) this Public-Environmental-Data-Partners/scripts repo to your own account. To do that, you must already be authorized to work in the PEDP GitHub. Then, go to https://github.com/Public-Environmental-Data-Partners/scripts, and then go to "Fork" and "Create New Fork". Set the Owner of the new fork to yourself. Name the fork "scripts" folder something else like pedp_scripts, so you can make sure you're not developing directly on the main branch.

Now do a clone to get the fork downloaded to your local machine. From there, develop in your local fork, and when you're ready to push your new code up to the main branch, use the workflow: stage, commit, push, open pull request. For pull requests, you can either open a new pull request from the main branch in GitHub, or use git.

# staging Files

• Add specific file
  • git add
• Add all changes in current directory
  • git add .
• Add all changes everywhere
  • git add -A

# commit

• Commit staged changes
  • git commit -m "Your message"

# push Commits to Sync with the Online Version of Your Fork

• Push to current branch
• git push

# other Useful Commands

• Pull latest changes from remote
  • git pull
• Check status of your repository
  • git status
• See what changed in your files
  • git diff
• Clone repository
  • git clone

# viewing History - use these commands to view commit history

• Full log
  • git log
• Last 5 commits
  • git log -5

# useful Combinations

• Quick commit all changes
  • git add -A && git commit -m "message" && git push
• See what will be pushed
• • git diff origin/master
• Sync with upstream (for forks)
• • git fetch upstream
• • git merge upstream/master