1
1
<div align =" center " >
2
2
<h1 > OpenVisionAPI Client </h1 >
3
3
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 )
6
5
7
6
</div >
8
7
@@ -19,7 +18,7 @@ You'll need to install:
19
18
20
19
Install the dependencies
21
20
22
- ```
21
+ ``` bash
23
22
$ just setup
24
23
```
25
24
@@ -32,7 +31,7 @@ $ poetry run ./ova.py detection /path/to/image
32
31
The available options for the cli:
33
32
34
33
``` bashh
35
- poetry run ./ova.py detection --help
34
+ $ poetry run ./ova.py detection --help
36
35
Usage: ova_client.py detection [OPTIONS] IMAGE
37
36
38
37
Options:
@@ -92,11 +91,11 @@ $ curl -X POST https://api.openvisionapi.com/api/v1/detection \
92
91
93
92
The configuration can be set up using the following env variables:
94
93
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 `
96
95
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 `
98
97
99
- ** RESULT_DIR ** : The directory where to store the result. The default is ` ./results `
98
+ < br >
100
99
101
100
## ⛏️ Built Using
102
101
@@ -105,6 +104,8 @@ The configuration can be set up using the following env variables:
105
104
- [ requests] ( https://github.com/psf/requests )
106
105
- [ pygments] ( https://github.com/pygments/pygments )
107
106
107
+ <br >
108
+
108
109
## 🤝 Contributing
109
110
110
111
Your contributions are welcome !
@@ -113,26 +114,30 @@ Your contributions are welcome !
113
114
114
115
To setup the development environment, simply run this command
115
116
116
- ```
117
+ ``` bash
117
118
$ just dev
118
119
```
119
120
120
121
### Code-style checks
121
122
122
123
ruff and mypy are used to ensure that contributions are stylized in a uniform manner.
123
124
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.
125
126
- [ mypy] ( https://github.com/python/mypy ) is used for static typing
126
127
128
+ <br >
129
+
127
130
## 🔧 Tests
128
131
129
132
To run the tests, simply run those commands
130
133
131
- ```
134
+ ``` bash
132
135
$ just dev
133
136
$ just test
134
137
```
135
138
139
+ <br >
140
+
136
141
## ⚖️ License
137
142
138
143
AGPLv3
0 commit comments