diff --git a/README.md b/README.md index bd521e072..efee66d10 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ## Golem application development -For a detailed introduction to using Golem and yapapi to run your tasks on Golem and a guide to Golem Network application development in general, [please consult our handbook](https://handbook.golem.network/requestor-tutorials/flash-tutorial-of-requestor-development). +For a detailed introduction to using Golem and yapapi to run your tasks on Golem and a guide to Golem Network application development in general, [please consult our docs](https://docs.golem.network/docs/quickstarts/python-quickstart). ### Installation @@ -125,13 +125,12 @@ poetry run poe clean * [Golem](https://golem.network), a global, open-source, decentralized supercomputer that anyone can access. * Learn what you need to know to set-up your Golem requestor node: - * [Requestor development: a quick primer](https://handbook.golem.network/requestor-tutorials/flash-tutorial-of-requestor-development) - * [Run first task on Golem](https://handbook.golem.network/requestor-tutorials/flash-tutorial-of-requestor-development/run-first-task-on-golem) -* Have a look at the most important concepts behind any Golem application: [Golem application fundamentals](https://handbook.golem.network/requestor-tutorials/golem-application-fundamentals) -* Learn about preparing your own Docker-like images for the [VM runtime](https://handbook.golem.network/requestor-tutorials/vm-runtime) +* [Requestor development: a quickstart](https://docs.golem.network/docs/quickstarts/python-quickstart) +* Have a look at the most important concepts behind any Golem application: [Golem application fundamentals](https://docs.golem.network/docs/creators/python/guides/application-fundamentals) +* Learn about preparing your own Docker-like images for the [VM runtime](https://docs.golem.network/docs/creators/python/examples/tools/converting-docker-image-to-golem-format) * Write your own app with yapapi: - * [Task Model development](https://handbook.golem.network/requestor-tutorials/task-processing-development) - * [Service Model development](https://handbook.golem.network/requestor-tutorials/service-development) + * [Task Model development](https://docs.golem.network/docs/creators/python/guides/task-model) + * [Service Model development](https://docs.golem.network/docs/creators/python/guides/service-model) ## Environment variables diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 00567cd98..f4968fbf9 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -6,6 +6,6 @@ Golem Python API Reference api - Golem Handbook + Golem Docs Github Pypi diff --git a/examples/utils/__init__.py b/examples/utils/__init__.py index 2cfd7755d..c74db37a7 100644 --- a/examples/utils/__init__.py +++ b/examples/utils/__init__.py @@ -80,15 +80,14 @@ def run_golem_example(example_main, log_file=None): try: loop.run_until_complete(task) except NoPaymentAccountError as e: - handbook_url = ( - "https://handbook.golem.network/requestor-tutorials/" - "flash-tutorial-of-requestor-development" + docs_url = ( + "https://docs.golem.network/docs/creators/python/quickstarts/run-first-task-on-golem" ) print( f"{TEXT_COLOR_RED}" f"No payment account initialized for driver `{e.required_driver}` " f"and network `{e.required_network}`.\n\n" - f"See {handbook_url} on how to initialize payment accounts for a requestor node." + f"See {docs_url} on how to initialize payment accounts for a requestor node." f"{TEXT_COLOR_DEFAULT}" ) except KeyboardInterrupt: diff --git a/tests/drone/drone.py b/tests/drone/drone.py index 0d2e79ce6..95a7917d0 100755 --- a/tests/drone/drone.py +++ b/tests/drone/drone.py @@ -119,15 +119,14 @@ async def worker(ctx: WorkContext, tasks): try: loop.run_until_complete(task) except NoPaymentAccountError as e: - handbook_url = ( - "https://handbook.golem.network/requestor-tutorials/" - "flash-tutorial-of-requestor-development" + docs_url = ( + "https://docs.golem.network/docs/creators/python/quickstarts/run-first-task-on-golem" ) print( f"{TEXT_COLOR_RED}" f"No payment account initialized for driver `{e.required_driver}` " f"and network `{e.required_network}`.\n\n" - f"See {handbook_url} on how to initialize payment accounts for a requestor node." + f"See {docs_url} on how to initialize payment accounts for a requestor node." f"{TEXT_COLOR_DEFAULT}" ) except KeyboardInterrupt: diff --git a/yapapi/payload/vm.py b/yapapi/payload/vm.py index 6cda613dc..857b419a2 100644 --- a/yapapi/payload/vm.py +++ b/yapapi/payload/vm.py @@ -100,7 +100,7 @@ async def manifest( Build a reference to application payload. :param manifest: base64 encoded Computation Payload Manifest - https://handbook.golem.network/requestor-tutorials/vm-runtime/computation-payload-manifest + https://docs.golem.network/docs/golem/payload-manifest#computation-payload-manifest :param manifest_sig: an optional signature of base64 encoded Computation Payload Manifest :param manifest_sig_algorithm: an optional signature algorithm, e.g. "sha256" :param manifest_cert: an optional base64 encoded public certificate (DER or PEM) matching key diff --git a/yapapi/services/service.py b/yapapi/services/service.py index 35ee7b769..9729bcb74 100644 --- a/yapapi/services/service.py +++ b/yapapi/services/service.py @@ -216,7 +216,7 @@ async def start(self) -> AsyncGenerator[Script, Awaitable[List[events.CommandEve check the `Default implementation` section for more details. As a handler implementing the `work generator pattern - `_, + `_, it's expected to be a generator that yields :class:`~yapapi.script.Script` (generated using the service's instance of the :class:`~yapapi.WorkContext` - :attr:`self._ctx`) that are then dispatched to the activity by the engine. @@ -287,7 +287,7 @@ async def run(self) -> AsyncGenerator[Script, Awaitable[List[events.CommandEvent Should contain any operations needed to ensure continuous operation of a service. As a handler implementing the `work generator pattern - `_, + `_, it's expected to be a generator that yields :class:`~yapapi.script.Script` (generated using the service's instance of the :class:`~yapapi.WorkContext` - :attr:`self._ctx`) that are then dispatched to the activity by the engine. @@ -332,7 +332,7 @@ async def shutdown(self) -> AsyncGenerator[Script, Awaitable[List[events.Command and gracefully shut-down - e.g. that its final state is retrieved. As a handler implementing the `work generator pattern - `_, + `_, it's expected to be a generator that yields :class:`~yapapi.script.Script` (generated using the service's instance of the :class:`~yapapi.WorkContext` - :attr:`self._ctx`) that are then dispatched to the activity by the engine.