diff --git a/docs/_pages/config.md b/docs/_pages/config.md index 69c88ca..f6302e1 100644 --- a/docs/_pages/config.md +++ b/docs/_pages/config.md @@ -114,3 +114,10 @@ These options are for the underlying FastAPI server: ||| |:---:|:---| |`debug`|Boolean to enable debug mode.| + +--- + +Next steps: + +1. Learn how to [serve static files](https://cutwell.github.io/python-web-io/docs/static/), such as images or CSS files. +2. Deep dive into customising your webpage using `print()` and `input()` [overrides](https://cutwell.github.io/python-web-io/docs/io/). \ No newline at end of file diff --git a/docs/_pages/index.md b/docs/_pages/index.md index d39d0a6..263cbc1 100644 --- a/docs/_pages/index.md +++ b/docs/_pages/index.md @@ -4,7 +4,17 @@ permalink: / [![Static Badge](https://img.shields.io/badge/-Cutwell%2FPython_Web_IO-white?logo=github&logoColor=white&labelColor=black&color=white&link=https%3A%2F%2Fgithub.com%2FCutwell%2Fpython-web-io)](https://github.com/Cutwell/python-web-io) [![PyPI](https://img.shields.io/pypi/v/python-web-io?style=flat-square)](https://pypi.org/project/python-web-io/) -Welcome to the Python web I/O docs. +# Why use Python Web I/O? -## License -MIT +## Ease of use +The initial concept of Python Web I/O was to enable users to generate web interfaces from any python application. Whilst this framework offers much more, this core feature enables instant integration with your Python projects. + +## Production-grade +We use [FastAPI](https://fastapi.tiangolo.com/) and [Uvicorn](https://www.uvicorn.org/) as backend technologies to power Python Web I/O. Used in combination, this tech stack elevates us beyond novelty, and into something that can be deployed and used in serious use-cases. + +## Highly customisable +Unlike other python-based web frameworks, we provide no pre-built components, in favour of allowing the user to develop HTML code to their precise specification. Greater customisablity = more power to the user. + +--- + +Ready to get started? Visit our [installation](https://cutwell.github.io/python-web-io/docs/install/) and [quickstart](https://cutwell.github.io/python-web-io/docs/quickstart/) pages for a complete POC setup. \ No newline at end of file diff --git a/docs/_pages/installation.md b/docs/_pages/installation.md index d6572d2..cf72fb2 100644 --- a/docs/_pages/installation.md +++ b/docs/_pages/installation.md @@ -18,3 +18,7 @@ If evaluating / testing `python-web-io`, install dependencies for the example ap ```bash poetry add python_web_io --with examples ``` + +--- + +Next steps: setup a POC with the [quickstart guide](https://cutwell.github.io/python-web-io/docs/quickstart/). \ No newline at end of file diff --git a/docs/_pages/io.md b/docs/_pages/io.md index fd1c8b3..a514b4f 100644 --- a/docs/_pages/io.md +++ b/docs/_pages/io.md @@ -113,3 +113,7 @@ input("What's your thoughts on Marmite?", type='radio', options=['love it', 'hat ``` + +--- + +Next steps: Learn how to [cache expensive functions](https://cutwell.github.io/python-web-io/docs/cache/) to improve latency. \ No newline at end of file diff --git a/docs/_pages/quickstart.md b/docs/_pages/quickstart.md index cdacdfa..35f3c5a 100644 --- a/docs/_pages/quickstart.md +++ b/docs/_pages/quickstart.md @@ -44,4 +44,8 @@ export OPENAI_API_KEY="" We recommend running `python_web_io` using `uvicorn`: ```bash poetry run uvicorn python_web_io.main:app -``` \ No newline at end of file +``` + +--- + +Next steps: Learn more about [project configuration](https://cutwell.github.io/python-web-io/docs/config/). \ No newline at end of file diff --git a/python-web-io/README.md b/python-web-io/README.md index 604a744..078748d 100644 --- a/python-web-io/README.md +++ b/python-web-io/README.md @@ -2,7 +2,7 @@ Generate a webpage as a GUI for a Python script, and serve from anywhere. ## Documentation -Check out the [wiki](https://github.com/Cutwell/python-web-io/wiki). +Check out the [wiki](https://cutwell.github.io/python-web-io/). ## Quickstart