adafruit-circuitpython-httpserver 4.5.8__tar.gz → 4.5.10__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/PKG-INFO +1 -1
  2. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_circuitpython_httpserver.egg-info/PKG-INFO +1 -1
  3. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_circuitpython_httpserver.egg-info/SOURCES.txt +1 -0
  4. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/__init__.py +1 -1
  5. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/conf.py +0 -1
  6. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/examples.rst +17 -0
  7. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_multiple_servers.py +3 -3
  8. adafruit_circuitpython_httpserver-4.5.10/examples/httpserver_video_stream.py +128 -0
  9. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/pyproject.toml +1 -1
  10. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +0 -0
  11. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.github/workflows/build.yml +0 -0
  12. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.github/workflows/failure-help-text.yml +0 -0
  13. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.github/workflows/release_gh.yml +0 -0
  14. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.github/workflows/release_pypi.yml +0 -0
  15. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.gitignore +0 -0
  16. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.pre-commit-config.yaml +0 -0
  17. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.pylintrc +0 -0
  18. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/.readthedocs.yaml +0 -0
  19. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/CODE_OF_CONDUCT.md +0 -0
  20. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/LICENSE +0 -0
  21. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/LICENSES/CC-BY-4.0.txt +0 -0
  22. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/LICENSES/MIT.txt +0 -0
  23. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/LICENSES/Unlicense.txt +0 -0
  24. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/README.rst +0 -0
  25. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/README.rst.license +0 -0
  26. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_circuitpython_httpserver.egg-info/dependency_links.txt +0 -0
  27. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_circuitpython_httpserver.egg-info/requires.txt +0 -0
  28. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_circuitpython_httpserver.egg-info/top_level.txt +0 -0
  29. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/authentication.py +0 -0
  30. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/exceptions.py +0 -0
  31. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/headers.py +0 -0
  32. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/interfaces.py +0 -0
  33. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/methods.py +0 -0
  34. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/mime_types.py +0 -0
  35. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/request.py +0 -0
  36. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/response.py +0 -0
  37. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/route.py +0 -0
  38. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/server.py +0 -0
  39. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/adafruit_httpserver/status.py +0 -0
  40. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/_static/favicon.ico +0 -0
  41. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/_static/favicon.ico.license +0 -0
  42. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/api.rst +0 -0
  43. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/api.rst.license +0 -0
  44. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/examples.rst.license +0 -0
  45. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/index.rst +0 -0
  46. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/index.rst.license +0 -0
  47. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/requirements.txt +0 -0
  48. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/starting_methods.rst +0 -0
  49. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/docs/starting_methods.rst.license +0 -0
  50. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/directory_listing.tpl.html +0 -0
  51. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/home.html +0 -0
  52. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_authentication_handlers.py +0 -0
  53. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_authentication_server.py +0 -0
  54. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_chunked.py +0 -0
  55. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_cookies.py +0 -0
  56. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_cpu_information.py +0 -0
  57. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_cpython.py +0 -0
  58. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_form_data.py +0 -0
  59. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_handler_serves_file.py +0 -0
  60. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_mdns.py +0 -0
  61. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_methods.py +0 -0
  62. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_neopixel.py +0 -0
  63. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_redirects.py +0 -0
  64. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_simpletest_auto_connection_manager.py +0 -0
  65. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_simpletest_auto_settings_toml.py +0 -0
  66. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_simpletest_manual_ap.py +0 -0
  67. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_simpletest_manual_ethernet.py +0 -0
  68. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_simpletest_manual_wifi.py +0 -0
  69. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_sse.py +0 -0
  70. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_start_and_poll.py +0 -0
  71. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_start_and_poll_asyncio.py +0 -0
  72. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_static_files_serving.py +0 -0
  73. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_templates.py +0 -0
  74. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_url_parameters.py +0 -0
  75. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/httpserver_websocket.py +0 -0
  76. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/examples/settings.toml +0 -0
  77. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/optional_requirements.txt +0 -0
  78. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/requirements.txt +0 -0
  79. {adafruit_circuitpython_httpserver-4.5.8 → adafruit_circuitpython_httpserver-4.5.10}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: adafruit-circuitpython-httpserver
3
- Version: 4.5.8
3
+ Version: 4.5.10
4
4
  Summary: Simple HTTP Server for CircuitPython
5
5
  Author-email: Adafruit Industries <circuitpython@adafruit.com>
6
6
  License: MIT
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: adafruit-circuitpython-httpserver
3
- Version: 4.5.8
3
+ Version: 4.5.10
4
4
  Summary: Simple HTTP Server for CircuitPython
5
5
  Author-email: Adafruit Industries <circuitpython@adafruit.com>
6
6
  License: MIT
@@ -72,5 +72,6 @@ examples/httpserver_start_and_poll_asyncio.py
72
72
  examples/httpserver_static_files_serving.py
73
73
  examples/httpserver_templates.py
74
74
  examples/httpserver_url_parameters.py
75
+ examples/httpserver_video_stream.py
75
76
  examples/httpserver_websocket.py
76
77
  examples/settings.toml
@@ -19,7 +19,7 @@ Implementation Notes
19
19
  https://github.com/adafruit/circuitpython/releases
20
20
  """
21
21
 
22
- __version__ = "4.5.8"
22
+ __version__ = "4.5.10"
23
23
  __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer.git"
24
24
 
25
25
 
@@ -116,7 +116,6 @@ napoleon_numpy_docstring = False
116
116
  import sphinx_rtd_theme
117
117
 
118
118
  html_theme = "sphinx_rtd_theme"
119
- html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
120
119
 
121
120
  # Add any paths that contain custom static files (such as style sheets) here,
122
121
  # relative to this directory. They are copied after the builtin static files,
@@ -352,6 +352,23 @@ This might change in the future, but for now, it is recommended to use Websocket
352
352
  :emphasize-lines: 12,20,65-72,88,99
353
353
  :linenos:
354
354
 
355
+ Custom response types e.g. video streaming
356
+ ------------------------------------------
357
+
358
+ The built-in response types may not always meet your specific requirements. In such cases, you can define custom response types and implement
359
+ the necessary logic.
360
+
361
+ The example below demonstrates a ``XMixedReplaceResponse`` class, which uses the ``multipart/x-mixed-replace`` content type to stream video frames
362
+ from a camera, similar to a CCTV system.
363
+
364
+ To ensure the server remains responsive, a global list of open connections is maintained. By running tasks asynchronously, the server can stream
365
+ video to multiple clients while simultaneously handling other requests.
366
+
367
+ .. literalinclude:: ../examples/httpserver_video_stream.py
368
+ :caption: examples/httpserver_video_stream.py
369
+ :emphasize-lines: 31-77,92
370
+ :linenos:
371
+
355
372
  Multiple servers
356
373
  ----------------
357
374
 
@@ -42,11 +42,11 @@ def home(request: Request):
42
42
  return Response(request, "Hello from home!")
43
43
 
44
44
 
45
- id_address = str(wifi.radio.ipv4_address)
45
+ ip_address = str(wifi.radio.ipv4_address)
46
46
 
47
47
  # Start the servers.
48
- bedroom_server.start(id_address, 5000)
49
- office_server.start(id_address, 8000)
48
+ bedroom_server.start(ip_address, 5000)
49
+ office_server.start(ip_address, 8000)
50
50
 
51
51
  while True:
52
52
  try:
@@ -0,0 +1,128 @@
1
+ # SPDX-FileCopyrightText: 2024 Michał Pokusa
2
+ #
3
+ # SPDX-License-Identifier: Unlicense
4
+
5
+ try:
6
+ from typing import Dict, List, Tuple, Union
7
+ except ImportError:
8
+ pass
9
+
10
+ from asyncio import create_task, gather, run, sleep
11
+ from random import choice
12
+
13
+ import socketpool
14
+ import wifi
15
+
16
+ from adafruit_pycamera import PyCamera
17
+ from adafruit_httpserver import Server, Request, Response, Headers, Status, OK_200
18
+
19
+
20
+ pool = socketpool.SocketPool(wifi.radio)
21
+ server = Server(pool, debug=True)
22
+
23
+
24
+ camera = PyCamera()
25
+ camera.display.brightness = 0
26
+ camera.mode = 0 # JPEG, required for `capture_into_jpeg()`
27
+ camera.resolution = "1280x720"
28
+ camera.effect = 0 # No effect
29
+
30
+
31
+ class XMixedReplaceResponse(Response):
32
+ def __init__(
33
+ self,
34
+ request: Request,
35
+ frame_content_type: str,
36
+ *,
37
+ status: Union[Status, Tuple[int, str]] = OK_200,
38
+ headers: Union[Headers, Dict[str, str]] = None,
39
+ cookies: Dict[str, str] = None,
40
+ ) -> None:
41
+ super().__init__(
42
+ request=request,
43
+ headers=headers,
44
+ cookies=cookies,
45
+ status=status,
46
+ )
47
+ self._boundary = self._get_random_boundary()
48
+ self._headers.setdefault(
49
+ "Content-Type", f"multipart/x-mixed-replace; boundary={self._boundary}"
50
+ )
51
+ self._frame_content_type = frame_content_type
52
+
53
+ @staticmethod
54
+ def _get_random_boundary() -> str:
55
+ symbols = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
56
+ return "--" + "".join([choice(symbols) for _ in range(16)])
57
+
58
+ def send_frame(self, frame: Union[str, bytes] = "") -> None:
59
+ encoded_frame = bytes(
60
+ frame.encode("utf-8") if isinstance(frame, str) else frame
61
+ )
62
+
63
+ self._send_bytes(
64
+ self._request.connection, bytes(f"{self._boundary}\r\n", "utf-8")
65
+ )
66
+ self._send_bytes(
67
+ self._request.connection,
68
+ bytes(f"Content-Type: {self._frame_content_type}\r\n\r\n", "utf-8"),
69
+ )
70
+ self._send_bytes(self._request.connection, encoded_frame)
71
+ self._send_bytes(self._request.connection, bytes("\r\n", "utf-8"))
72
+
73
+ def _send(self) -> None:
74
+ self._send_headers()
75
+
76
+ def close(self) -> None:
77
+ self._close_connection()
78
+
79
+
80
+ stream_connections: List[XMixedReplaceResponse] = []
81
+
82
+
83
+ @server.route("/frame")
84
+ def frame_handler(request: Request):
85
+ frame = camera.capture_into_jpeg()
86
+
87
+ return Response(request, body=frame, content_type="image/jpeg")
88
+
89
+
90
+ @server.route("/stream")
91
+ def stream_handler(request: Request):
92
+ response = XMixedReplaceResponse(request, frame_content_type="image/jpeg")
93
+ stream_connections.append(response)
94
+
95
+ return response
96
+
97
+
98
+ async def send_stream_frames():
99
+ while True:
100
+ await sleep(0.1)
101
+
102
+ frame = camera.capture_into_jpeg()
103
+
104
+ for connection in iter(stream_connections):
105
+ try:
106
+ connection.send_frame(frame)
107
+ except BrokenPipeError:
108
+ connection.close()
109
+ stream_connections.remove(connection)
110
+
111
+
112
+ async def handle_http_requests():
113
+ server.start(str(wifi.radio.ipv4_address))
114
+
115
+ while True:
116
+ await sleep(0)
117
+
118
+ server.poll()
119
+
120
+
121
+ async def main():
122
+ await gather(
123
+ create_task(send_stream_frames()),
124
+ create_task(handle_http_requests()),
125
+ )
126
+
127
+
128
+ run(main())
@@ -12,7 +12,7 @@ requires = [
12
12
  [project]
13
13
  name = "adafruit-circuitpython-httpserver"
14
14
  description = "Simple HTTP Server for CircuitPython"
15
- version = "4.5.8"
15
+ version = "4.5.10"
16
16
  readme = "README.rst"
17
17
  authors = [
18
18
  {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}