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: README.md
+4-8Lines changed: 4 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,10 +116,6 @@ The dev container sits on the same network, `gateway-local`, as [the `gateway-ap
116
116
117
117
- A container runtime such as [Docker](https://docs.docker.com/engine/install/) (Linux/WSL) or [Colima](https://github.com/abiosoft/colima) (macOS)
118
118
119
-
### External Dependencies
120
-
121
-
This project depends on the [clinical-data-common](https://github.com/NHSDigital/clinical-data-common) library for shared utilities. It is declared as a Git dependency in `gateway-api/pyproject.toml` and installed automatically by Poetry.
122
-
123
119
## Usage
124
120
125
121
The project uses `make` targets to build, deploy, and manage the application. Run these from the repository root:
@@ -157,11 +153,11 @@ Environment variables control whether stubs are used in place of the real PDS, S
157
153
| Variable | Description |
158
154
| --- | --- |
159
155
|`PDS_URL`| The URL for the PDS FHIR API; set as `stub` to use development stub. |
160
-
|`PDS_API_TOKEN`| Leave unset in development environment. |
161
-
|`PDS_API_SECRET`| Leave unset in development environment. |
162
-
|`PDS_API_KID`| Leave unset in development environment. |
156
+
|`PDS_API_TOKEN`| Leave unset in development environment. |
157
+
|`PDS_API_SECRET`| Leave unset in development environment. |
158
+
|`PDS_API_KID`| Leave unset in development environment. |
163
159
|`SDS_URL`| The URL for the SDS FHIR API; set as `stub` to use development stub. |
164
-
|`SDS_API_TOKEN`| Leave unset in development environment. |
160
+
|`SDS_API_TOKEN`| Leave unset in development environment. |
165
161
|`PROVIDER_URL`| The URL for the GP Provider; set as `stub` to use development stub. |
166
162
|`CDG_DEBUG`|`true`, return additional debug information when the call to the GP provider returns an error. |
Copy file name to clipboardExpand all lines: gateway-api/README.md
+2-16Lines changed: 2 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -114,31 +114,17 @@ gateway-api/
114
114
Specified under `[tool.poetry.dependencies]` in `pyproject.toml`:
115
115
116
116
| Package | Description |
117
-
|---|---|
117
+
|---|---|
118
118
|`flask`| Web framework powering the Gateway API |
119
119
|`requests`| HTTP client for calling PDS, SDS, and GP provider APIs |
120
120
|`types-flask`| Type stubs for Flask (used by mypy) |
121
-
|`clinical-data-common`| Shared NHSE library for common utilities ([GitHub repo](https://github.com/NHSDigital/clinical-data-common)) |
122
-
123
-
The `clinical-data-common` dependency is pinned to a Git tag in `pyproject.toml`:
124
-
125
-
```toml
126
-
[tool.poetry.dependencies]
127
-
clinical-data-common = { git = "https://github.com/NHSDigital/clinical-data-common.git", tag = "v0.1.0" }
128
-
```
129
-
130
-
To update it to a newer tag or version:
131
-
132
-
```bash
133
-
poetry update clinical-data-common
134
-
```
135
121
136
122
### Dev Dependencies
137
123
138
124
Specified under `[dependency-groups] dev` in `pyproject.toml`:
139
125
140
126
| Package | Description |
141
-
|---|---|
127
+
|---|---|
142
128
|`mypy`| Static type checker (strict mode enabled) |
143
129
|`pytest`| Test runner |
144
130
|`pytest-bdd`| BDD-style acceptance tests with Gherkin feature files |
0 commit comments