Skip to content

Commit 8a8ceca

Browse files
committed
add to readme
1 parent a8a951c commit 8a8ceca

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ Alternatively to build from source, clone this repo then inside the project's ba
1616
pip install .
1717
```
1818

19+
### Un-installation
20+
21+
To uninstall `centml`, simple do:
22+
```bash
23+
pip uninstall centml
24+
```
25+
1926
### CLI
2027
Once installed, use the centml CLI tool with the following command:
2128
```bash
@@ -85,3 +92,30 @@ To run all the tests, use:
8592
```bash
8693
pytest
8794
```
95+
96+
### Common Issues
97+
98+
- **`SSL` certificate on `MacOS`**
99+
100+
Sometimes, you will see issues when using command like `centml cluster [CMD]`, where the output might look like:
101+
102+
```logs
103+
104+
File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/urllib3/util/retry.py", line 519, in increment
105+
106+
raise MaxRetryError(_pool, url, reason) from reason # type: ignore[arg-type]
107+
108+
urllib3.exceptions.MaxRetryError: HTTPSConnectionPool(host='api.centml.com', port=443):
109+
110+
Max retries exceeded with url: /deployments
111+
112+
(Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1007)')))
113+
```
114+
115+
**Solution**:
116+
To fix this issue, navigate to your `python` installation directory and run the `Install Certificates.command` file located there.
117+
118+
For example, if you are using `python3.10`, the file path would be:
119+
`
120+
/Applications/Python 3.10/Install Certificates.command
121+
`

0 commit comments

Comments
 (0)