reformatted to support CLI execution

Author: Cutwell

.gitignore

@@ -1,8 +1,9 @@
-# Created by https://www.toptal.com/developers/gitignore/api/python,dotenv,venv
-# Edit at https://www.toptal.com/developers/gitignore?templates=python,dotenv,venv
+# Created by https://www.toptal.com/developers/gitignore/api/python,direnv
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,direnv
 
-### dotenv ###
-.env
+### direnv ###
+.direnv
+.envrc
 
 ### Python ###
 # Byte-compiled / optimized / DLL files
@@ -127,6 +128,7 @@ celerybeat.pid
 *.sage.py
 
 # Environments
+.env
 .venv
 env/
 venv/
@@ -175,16 +177,4 @@ poetry.toml
 # LSP config files
 pyrightconfig.json
 
-### venv ###
-# Virtualenv
-# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
-[Bb]in
-[Ii]nclude
-[Ll]ib
-[Ll]ib64
-[Ll]ocal
-[Ss]cripts
-pyvenv.cfg
-pip-selfcheck.json
-
-# End of https://www.toptal.com/developers/gitignore/api/python,dotenv,venv
+# End of https://www.toptal.com/developers/gitignore/api/python,direnv

.python_version

@@ -0,0 +1 @@
+3.10.11

README.md

@@ -1,11 +1,19 @@
 # Python Web I/O
  Generate a webpage as a GUI for a Python script, and serve from anywhere.
 
+## Install
+```
+$ pip install python-web-io
+$ export FLASK_SECRET_KEY="someSecureSecretKey"
+$ python_web_io .\example.py
+```
+
 ## Getting started
 1. Fork this repository.
-2. Create a `.env` file in `/python_web_io` according to `/python_web_io/.env.example` (use any random if testing key).
+From inside `/python_web_io`:
+2. Create a `.envrc` file, setting `FLASK_SECRET_KEY` as per `python_web_io/.envrc.example`.
 3. Install poetry dependencies with `poetry install`.
-4. Try running the `example.py` script using `poetry run python .\python_web_io\main.py .\example.py`. (Note: on Windows you may need to intialise poetry as a virtual environment, then try `python .\python_web_io\main.py .\example.py` from a terminal with the virtual environment activated)
+4. Try running the `example.py` script using `poetry run python python_web_io example.py`.
 
 ## Config
 |Argument|||

python_web_io/.env.example python_web_io/.envrc.examplepython_web_io/.env.example renamed to python_web_io/.envrc.example

@@ -1,17 +1,13 @@
 [tool.poetry]
 name = "python-web-io"
-version = "0.1.0"
-description = ""
+version = "0.1.8"
+description = "Generate a webpage as a GUI for a Python script, and serve from anywhere."
 authors = ["Zachary Smith"]
 packages = [{include = "python_web_io"}]
 
-[tool.poetry.scripts]
-python_web_io = "python_web_io.main:start"
-
 [tool.poetry.dependencies]
 python = "^3.10"
 flask = "^2.2.3"
-python-dotenv = "^1.0.0"
 flask-session = "^0.4.0"
 
 [tool.poetry.group.dev.dependencies]
@@ -21,3 +17,6 @@ pre-commit = "^3.2.2"
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+python_web_io = "python_web_io.main:start"

python_web_io/README.md

@@ -0,0 +1,2 @@
+from python_web_io.main import start
+start()