diff --git a/README.md b/README.md index c5a23ba..2aceeda 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,21 @@ Script will load your api key from this file on load if available. # example `.env` file content EVDS_API_KEY=AxByCzDsFoGmHeIgJaKrLbMaNgOe ``` - + +## Proxy from .env file + +You may also define your proxies as below in your `.env` file. +Script will load your proxies this file if available. + +```bash +# example `.env` file content +EVDS_API_KEY=AxByCzDsFoGmHeIgJaKrLbMaNgOe +PROXY_http=http://proxy.example.com:80 +PROXY_https=http://proxy.example.com:80 + +``` + + ### api_key inside get_series function [Alternative 2] diff --git a/docs/source/index.rst b/docs/source/index.rst index 15c3656..146c2f3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,7 +15,7 @@ Welcome to evdspy's documentation! setup save menu - + proxy Indices and tables ================== diff --git a/docs/source/proxy.rst b/docs/source/proxy.rst new file mode 100644 index 0000000..101f072 --- /dev/null +++ b/docs/source/proxy.rst @@ -0,0 +1,16 @@ +Proxy Configuration +=================== + +You can configure proxies for your application by defining them in a `.env` file. The script will load your proxies from this file if it is available. + +Creating a `.env` File +---------------------- + +Create a `.env` file in the root directory of your project and define your proxies as shown below: + +```bash +# Example .env file content +EVDS_API_KEY=AxByCzDsFoGmHeIgJaKrLbMaNgOe +PROXY_http=http://proxy.example.com:80 +PROXY_https=http://proxy.example.com:80 +``` \ No newline at end of file