Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

Commit

Permalink
update documentation of the serve command
Browse files Browse the repository at this point in the history
  • Loading branch information
radufalcusan committed Apr 18, 2024
1 parent 3d4485d commit a9796f5
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
6 changes: 2 additions & 4 deletions src/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ _See code: [dist/commands/run/index.ts](https://github.com/PlanQK/planqk-cli/tre

## `planqk serve`

Runs your current service code in a containerized environment to expose it through a local web server, similarly to how the PlanQK Platform would run your code. The local web server exposes the same RESTful HTTP endpoints to start a service execution, to check the status of running executions, to cancel executions, and to retrieve execution results.
Runs your current service code within a containerized environment, accessible through a local web server, mirroring the functionality of the PlanQK Platform. The local web server exposes the RESTful HTTP endpoints to start a service execution, to check the status of running executions, to cancel executions, and to retrieve execution results.

```
USAGE
Expand All @@ -258,9 +258,7 @@ FLAGS
-p, --port=<value> The port on which the local web server accepts requests
DESCRIPTION
Runs your current service code in a containerized environment to expose it through a local web server, similarly to
how the PlanQK Platform would run your code. The local web server exposes the same RESTful HTTP endpoints to start a
service execution, to check the status of running executions, to cancel executions, and to retrieve execution results.
Runs your current service code within a containerized environment, accessible through a local web server, mirroring the functionality of the PlanQK Platform. The local web server exposes the RESTful HTTP endpoints to start a service execution, to check the status of running executions, to cancel executions, and to retrieve execution results.
EXAMPLES
$ planqk serve -p <port>
Expand Down
2 changes: 1 addition & 1 deletion src/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* [D-Wave Service on PlanQK](tutorial-dwave.md)
* [Execute Qiskit Circuits with the PlanQK Quantum SDK](tutorial-qiskit.md)
* [Create and Test an On-premise Service](tutorial-meter-external-service.md)
* [Utilize the PlanQK Service SDK for local development using PlanQK CLI](tutorial-local-testing-with-cli-and-service-sdk.md)
* [Utilize the PlanQK Service SDK for Local Development](tutorial-local-testing-with-cli-and-service-sdk.md)

# Cookbooks

Expand Down
13 changes: 7 additions & 6 deletions src/tutorials/tutorial-local-testing-with-cli-and-service-sdk.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Utilize the PlanQK Service SDK for local development using PlanQK CLI
# Utilize the PlanQK Service SDK for Local Development

This tutorial outlines how to create, check the status and cancel service executions using both the PlanQK Service SDK and PlanQK CLI.
This tutorial provides step-by-step guidance on how to create services, monitor their statuses, retrieve their results, and cancel their executions locally. To accomplish this objective, the tutorial utilizes the PlanQK Service SDK and PlanQK CLI.


## Using PlanQK CLI
## Deploying the Services locally with the PlanQK CLI

Begin by navigating to the directory where your project, containing the service, is located.

Expand All @@ -17,9 +16,11 @@ Next, run the following command:
planqk serve
```

Once the server is up and running, you can utilize http://localhost:8081/ as the URL to access the API. For additional details regarding the `planqk serve` functionality, please refer to the documentation available [here](https://docs.platform.planqk.de/cli-reference.html#planqk-serve).
Once the SERVICE is up and running, you can access its API under http://localhost:8081/. For additional details regarding the `planqk serve` functionality, please refer to the documentation available [here](https://docs.platform.planqk.de/cli-reference.html#planqk-serve).

## Accessing a Service with the PlanQK Service SDK

## Getting Started with PlanQK Service SDK
Supported operations are: creating, monitoring the status of the service, retrieving the execution result and cancelling the execution of the service.

Begin by installing the PlanQK Service SDK using pip.

Expand Down

0 comments on commit a9796f5

Please sign in to comment.