Skip to content

Latest commit

 

History

History
100 lines (68 loc) · 2.42 KB

api.rst

File metadata and controls

100 lines (68 loc) · 2.42 KB
Raw

Golem Python API Reference

GolemNode

.. autoclass:: yapapi.mid.golem_node.GolemNode
    :members: __init__, __aenter__, __aexit__,
              create_allocation, create_demand,
              allocation, demand, proposal, agreement,
              allocations, demands,
              event_bus

High-Level API

[Nothing here yet. Task API, Service API etc.]

Mid-level API

Mid-level API consists of reusable components that can serve as a building blocks for various different applications.

Important temporary note: this will be easier to understand after reading the run.py example.

Chain

.. autoclass:: yapapi.mid.chain.Chain

Chain components

Components in this section can be used as parts of the Chain (but don't have to).

.. autoclass:: yapapi.mid.chain.SimpleScorer
    :members: __init__, __call__


.. autoclass:: yapapi.mid.chain.DefaultNegotiator
    :members: __init__, __call__


.. autoclass:: yapapi.mid.chain.AgreementCreator
    :members: __call__

Low-level API

Low-level objects correspond to resources in the Golem Network. They make no assumptions about any higher-level components that interact with them. Capabilities of the low-level API should match yagna capabilities, i.e. anything one can do by direct yagna interactions should also be possible - and, hopefully, more convenient - by performing operations on the low-level objects.

Resource

.. autoclass:: yapapi.mid.resource.Resource
    :members: id, node,
              get_data, data,
              parent, children, child_aiter,
              events,

Market API

.. autoclass:: yapapi.mid.market.Demand
    :members: initial_proposals, start_collecting_events, stop_collecting_events, unsubscribe, proposal


.. autoclass:: yapapi.mid.market.Proposal
    :members: initial, draft, rejected, demand,
              respond, responses, reject, create_agreement


.. autoclass:: yapapi.mid.market.Agreement
    :members: confirm, wait_for_approval, terminate

Payment API

.. autoclass:: yapapi.mid.payment.Allocation
    :members: release

Events

.. autoclass:: yapapi.mid.event_bus.EventBus
    :members: listen, resource_listen, emit


.. automodule:: yapapi.mid.events
    :members:

Logging

.. autoclass:: yapapi.mid.default_logger.DefaultLogger
    :members: __init__, file_name, logger, on_event