Project¶
- class pyinaturalist.models.Project(id=None, banner_color=None, created_at=NOTHING, description=None, header_image_url=None, hide_title=None, icon=None, is_umbrella=None, location=None, place_id=None, prefers_user_trust=None, project_observation_rules=NOTHING, project_type=None, rule_preferences=NOTHING, search_parameters=NOTHING, site_features=NOTHING, slug=None, terms=None, title=None, updated_at=None, user_ids=NOTHING, admins=NOTHING, project_observation_fields=NOTHING, user=None)¶
Bases:
pyinaturalist.models.base.BaseModel
An iNaturalist project, based on the schema of GET /projects.
Attributes
Name
Type
Description
id
Unique record ID
banner_color
created_at
Date and time the project was created
description
Project description
header_image_url
hide_title
icon
URL for project icon
is_umbrella
Indicates if this is an umbrella project (containing observations from other projects)
location
Location in
(latitude, logitude)
decimal degreesplace_id
Project place ID
prefers_user_trust
Indicates if the project wants users to share hidden coordinates with the project admins
project_observation_rules
Project observation rules
project_type
Project type
Options:
assessment
,bioblitz
,collection
,umbrella
rule_preferences
search_parameters
Filters for observations to include
site_features
Details about if/when the project was featured on inaturalist.org
slug
URL slug
terms
Project terms
title
Project title
updated_at
Date and time the project was last updated
user_ids
obs_fields (
property
)obs_rules (
property
)url (
property
)Info URL on iNaturalist.org
admins (
LazyProperty
)Project admin users
project_observation_fields (
LazyProperty
)Observation fields used by the project
user (
LazyProperty
)User that created the project
Methods
- __init__(id=None, banner_color=None, created_at=NOTHING, description=None, header_image_url=None, hide_title=None, icon=None, is_umbrella=None, location=None, place_id=None, prefers_user_trust=None, project_observation_rules=NOTHING, project_type=None, rule_preferences=NOTHING, search_parameters=NOTHING, site_features=NOTHING, slug=None, terms=None, title=None, updated_at=None, user_ids=NOTHING, admins=NOTHING, project_observation_fields=NOTHING, user=None)¶
Method generated by attrs for class Project.
- classmethod from_json(value, **kwargs)¶
Initialize a single model object from an API response or response result.
Omits any invalid fields and
None
values, so default factories are used instead (e.g. for empty dicts and lists).
- classmethod from_json_file(value)¶
Initialize a collection of model objects from a JSON string, file path, or file-like object
- classmethod from_json_list(value)¶
Initialize a collection of model objects from an API response or response results