Skip to content

Commit cc8b552

Browse files
committed
update Readme
1 parent 7f8f9bb commit cc8b552

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

Readme.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
<div align="center">
22
<h1> OpenVisionAPI Client </h1>
33

4-
[![Status](https://img.shields.io/badge/status-active-success.svg)]()
5-
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
4+
![Static Badge](https://img.shields.io/badge/AGPLV3-License?style=for-the-badge&label=LIcense)
65

76
</div>
87

@@ -19,7 +18,7 @@ You'll need to install:
1918

2019
Install the dependencies
2120

22-
```
21+
```bash
2322
$ just setup
2423
```
2524

@@ -32,7 +31,7 @@ $ poetry run ./ova.py detection /path/to/image
3231
The available options for the cli:
3332

3433
```bashh
35-
poetry run ./ova.py detection --help
34+
$ poetry run ./ova.py detection --help
3635
Usage: ova_client.py detection [OPTIONS] IMAGE
3736
3837
Options:
@@ -92,11 +91,11 @@ $ curl -X POST https://api.openvisionapi.com/api/v1/detection \
9291

9392
The configuration can be set up using the following env variables:
9493

95-
**DETECTION_URL** : The URL to the OpenVisionAPI server. The default is `https://api.openvisionapi.com/api/v1/detection`
94+
**OVA_DETECTION_URL** : The URL to the OpenVisionAPI server. The default is `https://api.openvisionapi.com/api/v1/detection`
9695

97-
**DETECTION_MODEL** : The object detection model to use. The default is `yolov4`
96+
**OVA_OUTPUT_DIR** : The directory where to store the result. The default is `./output`
9897

99-
**RESULT_DIR** : The directory where to store the result. The default is `./results`
98+
<br>
10099

101100
## ⛏️ Built Using
102101

@@ -105,6 +104,8 @@ The configuration can be set up using the following env variables:
105104
- [requests](https://github.com/psf/requests)
106105
- [pygments](https://github.com/pygments/pygments)
107106

107+
<br>
108+
108109
## 🤝 Contributing
109110

110111
Your contributions are welcome !
@@ -113,26 +114,30 @@ Your contributions are welcome !
113114

114115
To setup the development environment, simply run this command
115116

116-
```
117+
```bash
117118
$ just dev
118119
```
119120

120121
### Code-style checks
121122

122123
ruff and mypy are used to ensure that contributions are stylized in a uniform manner.
123124

124-
- [Ruff](https://github.com/astral-sh/ruff) is used as a linter and a code formatter.
125+
- [ruff](https://github.com/astral-sh/ruff) is used as a linter and a code formatter.
125126
- [mypy](https://github.com/python/mypy) is used for static typing
126127

128+
<br>
129+
127130
## 🔧 Tests
128131

129132
To run the tests, simply run those commands
130133

131-
```
134+
```bash
132135
$ just dev
133136
$ just test
134137
```
135138

139+
<br>
140+
136141
## ⚖️ License
137142

138143
AGPLv3

0 commit comments

Comments
 (0)