Skip to content

Commit

Permalink
Merge branch 'main' into extract-metabase-data
Browse files Browse the repository at this point in the history
  • Loading branch information
jb3 authored May 13, 2021
2 parents ab06c99 + 7fe0421 commit 05ddf43
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ log.*

# Custom user configuration
config.yml
docker-compose.override.yml

# xmlrunner unittest XML reports
TEST-**.xml
Expand Down
2 changes: 1 addition & 1 deletion bot/exts/info/code_snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

GITHUB_RE = re.compile(
r'https://github\.com/(?P<repo>[a-zA-Z0-9-]+/[\w.-]+)/blob/'
r'(?P<path>[^#>]+)(\?[^#>]+)?(#L(?P<start_line>\d+)([-~:]L(?P<end_line>\d+))?)'
r'(?P<path>[^#>]+)(\?[^#>]+)?(#L(?P<start_line>\d+)(([-~:]|(\.\.))L(?P<end_line>\d+))?)'
)

GITHUB_GIST_RE = re.compile(
Expand Down
23 changes: 23 additions & 0 deletions bot/resources/tags/dotenv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Using .env files in Python**

`.env` (dotenv) files are a type of file commonly used for storing application secrets and variables, for example API tokens and URLs, although they may also be used for storing other configurable values. While they are commonly used for storing secrets, at a high level their purpose is to load environment variables into a program.

Dotenv files are especially suited for storing secrets as they are a key-value store in a file, which can be easily loaded in most programming languages and ignored by version control systems like Git with a single entry in a `.gitignore` file.

In python you can use dotenv files with the [`python-dotenv`](https://pypi.org/project/python-dotenv) module from PyPI, which can be installed with `pip install python-dotenv`. To use dotenv files you'll first need a file called `.env`, with content such as the following:
```
TOKEN=a00418c85bff087b49f23923efe40aa5
```
Next, in your main Python file, you need to load the environment variables from the dotenv file you just created:
```py
from dotenv import load_dotenv()

load_dotenv(".env")
```
The variables from the file have now been loaded into your programs environment, and you can access them using `os.getenv()` anywhere in your program, like this:
```py
from os import getenv

my_token = getenv("TOKEN")
```
For further reading about tokens and secrets, please read [this explanation](https://vcokltfre.dev/tips/tokens).
2 changes: 1 addition & 1 deletion bot/resources/tags/ytdl.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Per [PyDis' Rule 5](https://pythondiscord.com/pages/rules), we are unable to assist with questions related to youtube-dl, commonly used by Discord bots to stream audio, as its use violates YouTube's Terms of Service.
Per [Python Discord's Rule 5](https://pythondiscord.com/pages/rules), we are unable to assist with questions related to youtube-dl, pytube, or other YouTube video downloaders as their usage violates YouTube's Terms of Service.

For reference, this usage is covered by the following clauses in [YouTube's TOS](https://www.youtube.com/static?gl=GB&template=terms), as of 2021-03-17:
```
Expand Down

0 comments on commit 05ddf43

Please sign in to comment.