ads.models.library

Library data model.

Classes

Library(*args, **kwargs)

A data model for a library managed by ADS.

class ads.models.library.Library(*args, **kwargs)[source]

A data model for a library managed by ADS.

id = <TextField: Library.id>

Unique identifier for this library, which is assigned by ADS.

num_users = <IntegerField: Library.num_users>

Number of users of the library.

num_documents = <IntegerField: Library.num_documents>

Number of documents in the library.

date_created = <DateTimeField: Library.date_created>

Date (UTC) the library was created.

date_last_modified = <DateTimeField: Library.date_last_modified>

Date (UTC) the library was last modified.

name = <TextField: Library.name>

Given name to the library.

description = <TextField: Library.description>

Description of the library.

public = <BooleanField: Library.public>

Whether the library is public.

owner = <TextField: Library.owner>

The ADS username of the owner of the library.

documents = <DocumentArrayField: Library.documents>

The documents in this library.

permissions = <PermissionsField: Library.permissions>

Permissions for the library.

union(*libraries)[source]

Return a new library that is the union of this library and the others.

Parameters

libraries – An iterable of libraries to union with this library.

Returns

A new library that is the union of this library and the others.

intersection(library)[source]

Take the intersection of this library with another.

Parameters

libraries – A list of libraries to take the intersection with this library.

Returns

A new library that is the intersection of this library and the other.

difference(library)[source]

Take the difference of two libraries.

Parameters

library – The library to take the difference with.

Returns

A new library that is the difference of this library and the other.

copy(library)[source]

Copy the bibcode contents from the this library to the given library.

This will not empty the first library.

Parameters

library – The library to copy to.

Returns

A boolean.

empty()[source]

Empty a library of all its documents.

delete()[source]

Delete this library from ADS.

DoesNotExist

alias of ads.models.library.LibraryDoesNotExist