Sections

Methods for drawing down, editing and creating sections of documents.

SectionClient

class documentcloud.sections.SectionClient

The section client gives access to retrieval and creation of sections on a given document. It is accessed as doc_obj.sections. The section client supports iteration, length and indexing so that it can be used directly as a sequence of the existing sections.

>>> for section in doc_obj.sections:
>>>     print(section)
>>> section_count = len(doc_obj.sections)
>>> second_section = doc_obj.sections[1]

all(self, **params)

An alias for list().

create(self, title, page_number)

Create a new section on this document. There may only be one section per page.

get(id_)

Return the section with the provided identifier.

list(self, **params)

Return a list of all sections on this document, possibly filtered by the given parameters. Please see the full API documentation for available parameters.

Section

class documentcloud.sections.Section

Sections of the documents earmarked by users.

put()

Save changes to a section back to DocumentCloud. You must be authorized to make these changes. Only the page_number, and title, attributes may be edited.

delete()

Delete a section from DocumentCloud. You must be authorized to make these changes.

save()

An alias for put() that saves changes back to DocumentCloud.

title

The name of the section.

page

The page where the section begins.

page_number

Alias to page.