diff --git a/.gitignore b/.gitignore index 80b48a7..12ec42a 100644 --- a/.gitignore +++ b/.gitignore @@ -149,3 +149,8 @@ temp # import linter .import_linter_cache + +# examples +!docs/examples/.env +!docs/examples/.env.dev +!docs/examples/.env.prod diff --git a/docs/assets/demo.gif b/docs/assets/demo.gif deleted file mode 100644 index 45f760a..0000000 Binary files a/docs/assets/demo.gif and /dev/null differ diff --git a/docs/demo.tape b/docs/demo.tape deleted file mode 100644 index 6f01cbf..0000000 --- a/docs/demo.tape +++ /dev/null @@ -1,49 +0,0 @@ -Output demo.gif - -Set FontSize 24 -Set Width 1920 -Set Height 1080 -Set BorderRadius 10 -Set TypingSpeed 0.5 -Set Theme "OneDark" -Set Shell "zsh" - -Type "echo 'Welcome to poetry-plugin-dotenv!'" -Enter -Sleep 10s -Ctrl+L - -Type "ls -a" -Enter -Sleep 10s -Ctrl+L - -Type "bat -p --paging=never main.py" -Enter -Sleep 10s -Ctrl+L - -Type "bat -p --paging=never .env" -Enter -Sleep 10s - -Type "poetry run -vvv python main.py" -Enter -Sleep 10s -Ctrl+L - -Type "bat -p --paging=never .env.dev" -Enter -Sleep 10s - -Type "export POETRY_DOTENV_LOCATION=.env.dev && poetry run -vvv python main.py" -Enter -Sleep 10s -Ctrl+L - -Type "export POETRY_DONT_LOAD_DOTENV=1 && poetry run -vvv python main.py" -Enter -Sleep 10s -Ctrl+L - -Ctrl+D diff --git a/docs/examples/.env b/docs/examples/.env new file mode 100644 index 0000000..14117af --- /dev/null +++ b/docs/examples/.env @@ -0,0 +1,5 @@ +DB__HOST=localhost +DB__DBNAME=local_lakehouse +DB__USER=volodymyr +DB__PASSWORD=super_secret_password +DB__ENGINE=postgresql://${DB__USER}:${DB__PASSWORD}@${DB__HOST}/${DB__DBNAME} diff --git a/docs/examples/.env.dev b/docs/examples/.env.dev new file mode 100644 index 0000000..5a01b51 --- /dev/null +++ b/docs/examples/.env.dev @@ -0,0 +1,5 @@ +DB__HOST=dev.host +DB__DBNAME=dev_lakehouse +DB__USER=svc_team +DB__PASSWORD=super_secret_password +DB__ENGINE=postgresql://${DB__USER}:${DB__PASSWORD}@${DB__HOST}/${DB__DBNAME} diff --git a/docs/examples/.env.prod b/docs/examples/.env.prod new file mode 100644 index 0000000..4546d50 --- /dev/null +++ b/docs/examples/.env.prod @@ -0,0 +1,5 @@ +DB__HOST=prod.host +DB__DBNAME=prod_lakehouse +DB__USER=svc_team +DB__PASSWORD=super_secret_password +DB__ENGINE=postgresql://${DB__USER}:${DB__PASSWORD}@${DB__HOST}/${DB__DBNAME} diff --git a/docs/examples/demo.tape b/docs/examples/demo.tape new file mode 100644 index 0000000..7762f38 --- /dev/null +++ b/docs/examples/demo.tape @@ -0,0 +1,42 @@ +Output ../assets/demo.gif + +Set FontSize 26 +Set Width 1920 +Set Height 1080 +Set Margin 20 +Set BorderRadius 10 +Set TypingSpeed 0.5 +Set Theme "Catppuccin Mocha" +Set WindowBar Colorful +Set Shell "zsh" + +Type "echo 'Welcome to poetry-plugin-dotenv!'" +Enter +Sleep 5s +Ctrl+L + +Type "ls -a" +Enter +Sleep 5s +Ctrl+L + +Type "bat -p main.py" +Enter +Sleep 5s +Ctrl+L + +Type "bat -p pyproject.toml" +Enter +Sleep 5s +Ctrl+L + +Type "bat -p .env.dev" +Enter +Sleep 5s + +Type "poetry run -vvv python main.py" +Enter +Sleep 5s +Ctrl+L + +Ctrl+D diff --git a/docs/examples/main.py b/docs/examples/main.py new file mode 100644 index 0000000..c894f85 --- /dev/null +++ b/docs/examples/main.py @@ -0,0 +1,17 @@ +"""Example script.""" # noqa: INP001 + +from __future__ import annotations + +import os + + +if __name__ == "__main__": + try: + print(f"Host: {os.environ['DB__HOST']!r}") # noqa: T201 + print(f"Name: {os.environ['DB__DBNAME']!r}") # noqa: T201 + print(f"Username: {os.environ['DB__USER']!r}") # noqa: T201 + print(f"Password: {os.environ['DB__PASSWORD']!r}") # noqa: T201 + print(f"Engine: {os.environ['DB__ENGINE']!r}") # noqa: T201 + + except KeyError: + print("Environment variables not set!") # noqa: T201