Projects

Methods for searching and retrieving projects.

ProjectClient

class muckrock.projects.ProjectClient

The project client allows access to search, list, and retrieve projects. Accessed generally as client.projects.

list(self, **params)

List all projects with optional filtering. Available filters include:

contributors: Filter by the unique identifier of a user associated with the project.
requests: Filter by projects which have this request associated with it.
title: Filter by the title of the project. Supports partial matches. Case sensitive.

Parameters:: params – Query parameters to filter results, such as contributors, requests, and title.
Returns:: An APIResults object containing the list of projects.

retrieve(self, project_id)

Retrieve a specific project by its ID

Parameters:: project_id – The unique ID of the project to retrieve.
Returns:: A Project object representing the requested project.

Project

class muckrock.projects.Project

A representation of a single project.

str(): Return a string representation of the project in format: Project {id} - Title: {title}.

id: The unique numerical identifier for the project.

title: The title of the project.

slug: A short, URL-friendly version of the project’s title.

summary: A brief summary of the project.

description: A detailed description of the project.

image: The image associated with the project (if available).

private: A boolean indicating whether the project is private (true) or public (false).

approved: A boolean indicating whether the project has been approved (true) or not (false).

featured: A boolean indicating whether the project is featured on the MuckRock site (true) or not (false).

contributors: A list of user IDs representing the contributors to the project.

articles: A list of article IDs associated with the project.

requests: A list of request IDs associated with the project.

date_created: The date and time when the project was created. If null, the creation date is not set.

date_approved: The date and time when the project was approved. If null, the approval date is not set.