library-of-life 0.4.2
A python client for the Global Biological Information Facility (GBIF) API
License: MIT
Requires Python: <4.0,>=3.8
Keywords: API, requests, client, gbif, biodata, biology, life, species

# library_of_life
`library_of_life` is a Python package that provides a client interface for interacting with the Global Biodiversity Information Facility (GBIF) API. The library is organized into submodules representing different APIs within the GBIF service, making it easy to access various resources related to biodiversity data.

## Table of Contents

- [Installation](#installation)
- [Quick Start](#quick-start)
- [Modules](#modules)
  - [Registry](#registry)
  - [Species](#species)
  - [Occurrence](#occurrences)
  - [Maps](#maps)
  - [Literature](#literature)
  - [Vocabulary](#vocabulary)
- [Caching](#caching)
- [Authentication](#authentication)
- [Contributing](#contributing)
- [Donating$$$](#donating)
- [License](#license)
- [Documentation](#documentation)

## Installation

You can install `library_of_life` via pip:

```bash
pip install library_of_life
```

## Quick Start

Here's a quick example to get you started with `library_of_life`:

```python
from library_of_life.registry.datasets import Datasets
from library_of_life.species.name_usage import NameUsage

# Initialize the Datasets and NameUsage classes
dataset_client = Datasets()
name_usage_client = NameUsage()

# List current datasets matching specified parameters
dataset = dataset_client.list_datasets(dataset_type="SAMPLING_EVENT", limit=10)
print(dataset)

# Return all vernacular species names by a specific usage key
vernacular_names= name_usage_client.get_usage_vernacular_names_by_usage_key(5231190)
print(vernacular_names)
```

## Modules

Each module is composed of separate submodules reflecting the divisions in the GBIF APIs. Within each of these submodules is a class and appropriate methods for accessing the data and resources available for the respective endpoints.

### Registry

For now the registry module only contains the principal methods, but it will be updated in the future to include all of the methods.

#### Submodules

- `datasets`
- `publishing_orgs`
- `participant_nodes`
- `networks`
- `tech_installations`
- `collections`
- `institutions`
- `institutions_and_collections`
- `derived_datasets`

### Species

#### Submodules

- `name_usage`
- `name_search`
- `name_parser`

### Occurrence

#### Submodules

- `single_occurrence`
- `search`
- `downloads`
- `download_format`
- `download_stats`
- `metrics`
- `inventories`
- `gadm_regions`
- `country_usages`
- `organization_usages`

### Maps

#### Submodules

- `maps`

### Literature

#### Submodules

- `literature`

### Vocabulary

#### Submodules

- `vocabularies`
- `concepts`
- `tags`
- `languages`

## Caching

Each class contains an optional caching feature using requests_cache. Simply set use_caching to True when initializing the respective class.

## Authentication

As some features of the GBIF API require authentication (POST, PUT, DETETE methods), this package handles both basic authentication (username and password) and OAuth2 authentication. This is dealt with at the class level. The default is for basic authentication, but if OAuth is desired, simply pass auth_type="OAuth" when initializing the class, as wellas the necessary credentials. Future versions may handle this with a config file.

## Contributing

Contributions are welcome! If you would like to contribute to the development of `library_of_life`, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature/your-feature`).
5. Create a new Pull Request.

## Donating$$$

If you find this project helpful and would like to support its development, consider making a donation.

[Donate via Paypal](https://www.paypal.com/donate/?hosted_button_id=N8HR4SN2J6FPG)

## License

This project is licensed under the MIT License. See the [LCENSE](LICENSE) file for more details.

## Documentation
For more information, read the [docs](#https://library-of-life.readthedocs.io/en/latest/modules.html)