Skip to content

docs: clarify GBIF_USER/GBIF_PWD requirements for download endpoints#200

Merged
jhnwllr merged 1 commit intogbif:masterfrom
LarytheLord:docs/clarify-gbif-download-credentials
Mar 5, 2026
Merged

docs: clarify GBIF_USER/GBIF_PWD requirements for download endpoints#200
jhnwllr merged 1 commit intogbif:masterfrom
LarytheLord:docs/clarify-gbif-download-credentials

Conversation

@LarytheLord
Copy link
Copy Markdown
Contributor

@LarytheLord LarytheLord commented Feb 25, 2026

Summary

  • add explicit note that occurrence download endpoints require GBIF credentials
  • document GBIF_USER and GBIF_PWD environment variables
  • note that user= and pwd= args can be passed directly

Files

  • README.rst
  • docs/modules/occurrence.rst

Fixes #94

@jhnwllr jhnwllr merged commit dcbdb64 into gbif:master Mar 5, 2026
5 checks passed
jhnwllr added a commit that referenced this pull request Mar 25, 2026
* Release/v0.6.6 (#185)

* Feature/grscicoll (#173)

Adding support for GRSciColl institution and collection search. Updating documentation and vcr fixtures.

* Adding support for species match v2 #176 (#177)

* preparing for new version 0.6.6

* updating ver

* fixing tests and fresh cassettes

* fixing build

* docs: clarify GBIF credentials required for downloads (#200)

* Add download statistics functions to occurrences module #201

- Add download_stats() for general download statistics
- Add download_stats_user_country() for user country stats
- Add download_stats_records_by_dataset() for records by dataset
- Add download_stats_by_dataset() for downloads by dataset
- Add download_stats_by_source() for downloads by source
- Add comprehensive test coverage for all new functions
- Update __init__.py to expose new functions
- Add .github/copilot-instructions.md to .gitignore

---------

Co-authored-by: Abi <[email protected]>
jhnwllr added a commit that referenced this pull request Apr 1, 2026
* Release/v0.6.6 (#185)

* Feature/grscicoll (#173)

Adding support for GRSciColl institution and collection search. Updating documentation and vcr fixtures.

* Adding support for species match v2 #176 (#177)

* preparing for new version 0.6.6

* updating ver

* fixing tests and fresh cassettes

* fixing build

* docs: clarify GBIF credentials required for downloads (#200)

* Use COL-style taxon keys in checklistKey examples

Update examples and tests to use COL-style taxon key (5WZLF) instead
of numeric GBIF Backbone taxon keys when demonstrating checklistKey
functionality. This aligns with ChecklistBank taxonomy format.

* Add checklistKey parameter support for occurrence downloads

- Added checklistKey parameter to download() function and GbifDownload class
- Supports root-level (global) usage: applies to entire download request
- Supports predicate-level usage: for filtering specific predicates
- Updated all examples to use COL-style taxon key (5WZLF)
- Added comprehensive tests for both usage patterns
- Updated documentation in occurrence.rst and download.py
- Updated Changelog.rst with feature description
- Maintains backward compatibility when checklistKey not provided

* documentaiton updates

* updating docs

* docs update

---------

Co-authored-by: Abi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCUMENTATION] GBIF_USER and GBIF_PWD missing but needed

2 participants