Skip to content

Commit

Permalink
Removed (in)convinience import of web api for #51
Browse files Browse the repository at this point in the history
  • Loading branch information
Gadgetoid committed Feb 20, 2018
1 parent 71fba2b commit 52a8a87
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
5 changes: 3 additions & 2 deletions documentation/REFERENCE.md
Expand Up @@ -146,8 +146,9 @@ y – Flip vertically up to down

flask must be installed before the api bluerint can be imported.
To build up a flask api using the blueprint you can use the following and add your own blueprints to the api as you choose:

```python
from scrollphathd import scrollphathd_blueprint
from scrollphathd.api.http import scrollphathd_blueprint
from flask import Flask


Expand All @@ -156,7 +157,7 @@ app.register_blueprint(scrollphathd_blueprint, url_prefix='/scrollphathd')
app.run()
```

Alternatively, with the module installed you should be able to run `scrollphathd_api` and optionally supply `-p|--port` and `-H|--host` which will start the same api as described above.
Alternatively, with the module installed you should be able to run `python -m scrollphathd.api.http` and optionally supply `-p|--port` and `-H|--host` which will start the same api as described above.


Both options will start a http flask server with the endpoints:
Expand Down
1 change: 0 additions & 1 deletion library/scrollphathd/__init__.py
@@ -1,5 +1,4 @@
from sys import version_info
from .api.http import start_background_thread, scrollphathd_blueprint
from . import is31fl3731

__version__ = '1.2.0'
Expand Down

0 comments on commit 52a8a87

Please sign in to comment.