Skip to content

Commit

Permalink
docs proxy
Browse files Browse the repository at this point in the history
  • Loading branch information
SermetPekin committed Aug 1, 2024
1 parent c308139 commit b48d8bc
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Welcome to evdspy's documentation!
setup
save
menu

proxy

Indices and tables
==================
Expand Down
16 changes: 16 additions & 0 deletions docs/source/proxy.rst
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit b48d8bc

Please sign in to comment.