Ian Cordasco 87a9c75ea3 Add Python API Reference documentation

This corrects some typos in earlier documentation patches, removes
outdated API reference documentation, and organizes all API reference
documentation under one chapter.

This also leaves room for future API versions and more specific API
reference documentation being broken out into sub-sections.

Change-Id: I5391a1acc7d1669207b3d10039a196d026216f40

2017-03-17 14:38:02 -05:00

3.2 KiB

Raw Blame History

Using the Cells API

Here we will assume that we already have a ~cratonclient.client.Client instance configured with the appropriate authentication method (as demonstrated in usage-auth).

Listing Cells

The Cells API implements pagination. This means that by default, it does not return all cells known to Craton. To ignore page limits and offsets, we can allow cratonclient to do handle pagination for us:

for cell in craton.cells.list():
    print_cell_info(cell)

By default ~cratonclient.v1.cells.CellManager.list will handle pagination for you. If, instead, you want to handle it yourself you will want to do something akin to:

first_page_of_cells = list(craton.cells.list(autopaginate=False))
marker_id = first_page_of_cells[-1].id
second_page_of_cells = list(craton.cells.list(
    autopaginate=False,
    marker=marker_id,
))
marker_id = second_page_of_cells[-1].id
third_page_of_cells = list(craton.cells.list(
    autopaginate=False,
    marker=marker_id,
))
# etc.

A more realistic example, however, might look like this:

cells_list = None
marker = None
while cells_list and cells_list is not None:
    cells_list = list(craton.cells.list(
        marker=marker,
        autopaginate=False,
    ))
    # do something with cells_list
    if cells_list:
        marker = cells_list[-1].id

This will have the effect of stopping the while loop when you eventually receive an empty list from craton.cells.list(...).

Creating Cells

Cells live below a Region in Craton. To create a cell, the only required items are a name for the cell, a cloud ID, and a region ID. The name must be unique among cells in the same project.

cell = craton.cells.create(
    name='my-cell-0',
    cloud_id=cloud_id,
    region_id=region_id,
    note='This is my cell, there are many like it, but this is mine.',
    variables={
        'some-var': 'some-var-value',
    },
)

Retrieving a Specific Cell

Cells can be retrieved by id.

cell = craton.cells.get(1)

Using a Cell's Variables

Once we have a cell we can introspect its variables like so:

cell = craton.cells.get(cell_id)
cell_vars = cell.variables.get()

To update them:

updated_vars = {
    'var-a': 'new-var-a',
    'var-b': 'new-var-b',
    'updated-var': 'updated value',
}
cell.variables.update(**updated_vars)

To delete them:

cell.variables.delete('var-a', 'var-b', 'updated-var')

Updating a Cell

We can update a cell's attributes (but not its variables) like so:

craton.cells.update(
    cell_id,
    name='new name',
    note='Updated note.',
)

Most attributes that you can specify on creation can also be specified for updating the cell as well.

Deleting a Cell

We can delete with only its id:

craton.cells.delete(cell_id)

3.2 KiB Raw Blame History