Skip to content

Commit

Permalink
chore: update manual.md
Browse files Browse the repository at this point in the history
style
  • Loading branch information
asmfstatoil committed May 6, 2024
1 parent 94b27db commit 1ddcea7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: '🧪 Build & test code'
name: "🧪 Build & test code"

on:
workflow_dispatch:
Expand All @@ -9,7 +9,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ['3.8', '3.9', '3.10', '3.11']
python-version: ["3.8", "3.9", "3.10", "3.11"]
os: [windows-latest, ubuntu-latest, macos-latest]
runs-on: ${{ matrix.os }}
steps:
Expand All @@ -29,7 +29,7 @@ jobs:
uses: actions/setup-python@v4
with:
python-version: ${{matrix.python-version}}
cache: 'poetry'
cache: "poetry"

- name: Check pyproject.toml validity
run: poetry check --no-interaction
Expand Down
4 changes: 2 additions & 2 deletions docs/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ pip install --upgrade tagreader
The Web APIs are queried with the requests package. Requests does not utilize the system certificate store, but instead relies on the certifi bundle. In order to avoid SSL verification errors, we need to either turn off SSL verification (optional input argument `verifySSL=False` for relevant function calls) or, strongly preferred, add the certificate to the certifi bundle. To do this, simply activate the virtual environment where you installed tagreader, and run the following snippet:

``` python
from tagreader.utils import add_statoil_root_certificate
add_statoil_root_certificate()
from tagreader.utils import add_equinor_root_certificate
add_equinor_root_certificate()
```

The output should inform you that the certificate was successfully added. This needs to be repeated whenever certifi is upgraded in your python virtual environment. It is safe to run more than once: If the function detects that the certificate has already been added to your current certifi installation, the certificate will not be duplicated.
Expand Down

0 comments on commit 1ddcea7

Please sign in to comment.