Skip to content

Commit 9a7895f

Browse files
📝 Add installation docs.
1 parent 92ddf76 commit 9a7895f

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

.config/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ docs_dir: ../docs
66
nav:
77
- index.md
88
- Usage:
9+
- usage/installation.md
910
- usage/client.md
1011
- usage/operation.md
1112
- usage/auth.md

docs/usage/installation.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Installation
2+
3+
Lapidary is a library, you can add it to your existing project, but I recommend creating a separate project for each remote service.
4+
5+
## Using poetry
6+
7+
With `poetry` you can install `lapidary` simply by typing:
8+
```shell
9+
poetry add lapidary
10+
```
11+
12+
## Using lapidary-render
13+
14+
If you have OpenAPI 3.0 document, you can initialize a project with lapidary-render:
15+
16+
```shell
17+
lapidary-render init
18+
```
19+
20+
or via pipx:
21+
22+
```shell
23+
pipx run lapidary-render init
24+
```
25+
26+
See [the documentation](/lapidary-render/) for more details.

0 commit comments

Comments
 (0)