Skip to content

Commit 828c4c5

Browse files
committed
chore: Renamed the pypi package to dap-python
1 parent 34b15d7 commit 828c4c5

File tree

5 files changed

+37
-7
lines changed

5 files changed

+37
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ DAP Client is an up-to-date generic client side implementation of the [Debug Ada
2121
Install DAP Client using pip:
2222

2323
```bash
24-
pip install dap-client
24+
pip install dap-python
2525
```
2626

2727
## Quick Start

docs/LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2024 billy
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Debug Adapter Client for Python
1+
# [DAP Client: Debug Adapter Protocol Client](https://tomlin7.github.io/dap/api-reference/)
22

3-
DAP Client is an up-to-date generic client side implementation of the [Debug Adapter Protocol (DAP)](https://microsoft.github.io/debug-adapter-protocol/) that is used in IDEs, editors and other tools to communicate with different debuggers. The client is not tied to any specific debugger, so it can be used to interact with any debug adapter that implements the DAP protocol, significantly reducing the effort required to build a new debugging tool.
3+
DAP Client is an up-to-date generic client side implementation of the [Debug Adapter Protocol (DAP)](https://microsoft.github.io/debug-adapter-protocol/) that is used in IDEs, editors and other tools to communicate with different debuggers. The client is not tied to any specific debugger, so it can be used to interact with any debug adapter that implements the DAP protocol, significantly reducing the effort required to build a new debugging tool. For a list of supported debug adapters, see the [official specification](https://microsoft.github.io/debug-adapter-protocol/implementors/adapters/).
44

55
## Key Features
66

@@ -13,15 +13,15 @@ DAP Client is an up-to-date generic client side implementation of the [Debug Ada
1313
1. [Installation](#installation)
1414
2. [Quick Start](#quick-start)
1515
3. [Usage Examples](#usage-examples)
16-
4. [API Reference](#api-reference)
16+
4. [API Reference](https://tomlin7.github.io/dap/api-reference/)
1717
5. [License](#license)
1818

1919
## Installation
2020

2121
Install DAP Client using pip:
2222

2323
```bash
24-
pip install dap-client
24+
pip install dap-python
2525
```
2626

2727
## Quick Start
@@ -112,4 +112,4 @@ asyncio.run(debug_session())
112112

113113
## License
114114

115-
DAP Client is released under the [MIT License](../LICENSE).
115+
DAP Client is released under the [MIT License](LICENSE.md)

mkdocs.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ theme:
2323
toggle:
2424
icon: material/weather-night
2525
name: Switch to light mode
26+
features:
27+
- navigation.top
28+
- toc.follow
2629

2730
plugins:
2831
- mkdocstrings:
@@ -36,3 +39,9 @@ plugins:
3639
nav:
3740
- Home: index.md
3841
- API Reference: api-reference.md
42+
- License: LICENSE.md
43+
44+
extra:
45+
social:
46+
- icon: fontawesome/brands/github
47+
link: https://github.com/tomlin7/dap

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[tool.poetry]
2-
name = "dap-client"
2+
name = "dap-python"
33
version = "0.5.0"
44
description = "Client for Debug Adapter Protocol"
55
authors = ["Billy <billydevbusiness@gmail.com>"]

0 commit comments

Comments
 (0)