Skip to content

Commit b0fdae3

Browse files
Add package.json to root
1 parent 4ad3067 commit b0fdae3

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,41 @@ This project contains two packages:
99

1010
For information on how to generate the packages out of an OpenAPI spec, please refer to the [README](.generation/README.md) file in the [`.generation`](.generation) directory.
1111

12+
## Usage during Development
13+
14+
Create a branch (`<BRANCH>`) with the changes you want to test and push it to the repository.
15+
16+
### Python
17+
18+
Update `setup.cfg` in the root directory of the repository to point to the branch you want to test.
19+
20+
```ini
21+
22+
23+
install_requires =
24+
geoengine-openapi-client @ git+https://github.com/geo-engine/openapi-client@<BRANCH>#subdirectory=python # TODO: update before merging
25+
26+
27+
```
28+
29+
### TypeScript
30+
31+
Update `package.json` in the root directory of the repository to point to the branch you want to test.
32+
33+
```json
34+
35+
36+
{
37+
"dependencies": {
38+
"@geoengine/openapi-client": "git://github.com/geo-engine/openapi-client.git#<BRANCH>",
39+
40+
}
41+
}
42+
43+
44+
```
45+
46+
1247
## License
1348

1449
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details

package.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"name": "@geoengine/openapi-client-dev",
3+
"description": "Dev wrapper for @geoengine/openapi-client",
4+
"private": true,
5+
"workspaces": [
6+
"typescript"
7+
],
8+
"main": "./typescript/index.js",
9+
"typings": "./typescript/dist/index.d.ts",
10+
"module": "./typescript/dist/esm/index.js",
11+
"scripts": {
12+
"build": "npm run build --workspace=typescript",
13+
"prepare": "npm run build --workspace=typescript"
14+
}
15+
}

0 commit comments

Comments
 (0)