Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add doc on using proxies #975

Merged
merged 1 commit into from
Feb 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ OWSLib |release| documentation
development
support
logging
proxies
license
credits
44 changes: 44 additions & 0 deletions docs/source/proxies.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Proxies Support
===============

OWSLib can be configured to work with proxy servers using environment variables.
These can either be set in a Python script (only affecting HTTP calls within that script), as in the example below:

.. code-block:: python

import os
from owslib.wms import WebMapService

os.environ['HTTP_PROXY'] = 'http://10.10.1.10:3128'
os.environ['HTTPS_PROXY'] = 'http://10.10.1.10:1080'
wms = WebMapService('https://gibs.earthdata.nasa.gov/wms/epsg4326/best/wms.cgi?', version='1.3.0')

Or through the operating system environment variables (Linux):

.. code-block:: bash

$ export HTTP_PROXY="http://10.10.1.10:3128"
$ export HTTPS_PROXY="http://10.10.1.10:1080"
$ export ALL_PROXY="socks5://10.10.1.10:3434"

$ python
>>> from owslib.wms import WebMapService
>>> wms = WebMapService('https://gibs.earthdata.nasa.gov/wms/epsg4326/best/wms.cgi?', version='1.3.0')

Windows (PowerShell):

.. code-block:: ps1

$env:HTTP_PROXY = "http://10.10.1.10:3128"
$env:HTTPS_PROXY = "http://10.10.1.10:1080"
$env:ALL_PROXY = "socks5://10.10.1.10:3434"

To use HTTP Basic Auth with your proxy, use the http://user:password@host/ syntax. For example:

.. code-block:: python

os.environ['HTTP_PROXY'] = 'http://username:password@10.10.1.10:3128'


For more details, refer to the `Requests library documentation <https://requests.readthedocs.io/en/latest/user/advanced/#proxies>`__,
which OWSLib uses for all HTTP requests.
Loading