Skip to content

Commit 934328e

Browse files
committed
Merge branch 'master' into fix/install-requirements-on-startup
2 parents 684533f + 0f792c3 commit 934328e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,10 @@ Since this template is based on the meinheld-gunicorn-docker image, all possible
325325
For hosting the app in a production setting, the template depends on [meinheld-gunicorn-docker](https://github.com/tiangolo/meinheld-gunicorn-docker). All [environment variables](https://github.com/tiangolo/meinheld-gunicorn-docker#environment-variables) used by meinheld-gunicorn can be used to configure your service as well.
326326

327327
## Other
328+
329+
### Reassigning `app`
330+
In regular Flask applications (e.g. those not run within this template) you are required to define `app` by using `app = Flask(__name__)` or similar. This does *not* need to be done in your web.py, as this is handled by the microservice architecture/template. Redefining this may cause `The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.` to be thrown on your routes, which can be luckily be fixed by simply removing the previously mentioned `app = ...` line.
331+
328332
### readme.py
329333
To simplify documenting the helper functions, `README.py` can be used to import & render the docstrings into README.md.
330334
Usage:
@@ -333,4 +337,3 @@ python3 -m pip install pydoc-markdown
333337
python3 README.py
334338
```
335339
You can customise the output through the API configuration! See [README.py](README.py) && the [pydoc-markdown docs](https://niklasrosenstein.github.io/pydoc-markdown/).
336-

0 commit comments

Comments
 (0)