You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/development/celery_task_implementation.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -258,7 +258,7 @@ The DivBase client uses the [Typer](https://typer.tiangolo.com/) library to buil
258
258
- There needs to be a Typer app (on the form `query_app = typer.Typer()`) to which the CLI command functions needs to be connected. The app needs to be initiated with `app.add_typer(query_app, name="query")` in `./packages/divbase-cli/src/divbase_cli/divbase_cli.py`.
259
259
- The typer app name is used as a decorator for the function, e.g. `@query_app.command("bcftools-pipe")`. The argument of the decorator will become the command for the CLI.
260
260
- Pack the task arguments in the Pydantic request model (see Section 2.2), e.g. `request_data=BcftoolsQueryRequest()` for type validation.
261
-
- The `resolve_project()` helper function is be used to fetch the data from the users local config and is needed for the established pattern to make the request. This helper function need that the CLI function args contain `project: str | None = PROJECT_NAME_OPTION,` and `config_file: Path = CONFIG_FILE_OPTION,`. See an existing CLI file for more details on the constants they are calling.
261
+
- The `resolve_project()` helper function is be used to fetch the data from the users local config and is needed for the established pattern to make the request. This helper function need that the CLI function args contain `project: str | None = PROJECT_NAME_OPTION,`. See an existing CLI file for more details on the constants they are calling.
262
262
- The main function call for all DivBase CLI->API interactions is `make_authenticated_request()`. If the user is logged in to the CLI, it sends the user's JSON Web Token as part of the request, which the API uses to validate the user's identity and project role/permissions.
263
263
- The arguments `method="POST",divbase_base_url=project_config.divbase_url` should always be included as is.
264
264
-`api_route` is the route URL defined in the corresponding endpoint (see Section 2.3).
@@ -281,7 +281,6 @@ def pipe_query(
281
281
command: str=BCFTOOLS_ARGUMENT,
282
282
metadata_tsv_name: str=METADATA_TSV_ARGUMENT,
283
283
project: str|None=PROJECT_NAME_OPTION,
284
-
config_file: Path =CONFIG_FILE_OPTION,
285
284
) -> None:
286
285
"""
287
286
Submit a query to run on the DivBase API. A single, merged VCF file will be added to the project's storage bucket on success.
0 commit comments