Coverage for .tox/coverage/lib/python3.11/site-packages/wuttaweb/static/__init__.py: 100%

1# -*- coding: utf-8; -*- 

2################################################################################ 

3# 

4# wuttaweb -- Web App for Wutta Framework 

5# Copyright © 2024 Lance Edgar 

6# 

7# This file is part of Wutta Framework. 

8# 

9# Wutta Framework is free software: you can redistribute it and/or modify it 

10# under the terms of the GNU General Public License as published by the Free 

11# Software Foundation, either version 3 of the License, or (at your option) any 

12# later version. 

13# 

14# Wutta Framework is distributed in the hope that it will be useful, but 

15# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 

16# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 

17# more details. 

18# 

19# You should have received a copy of the GNU General Public License along with 

20# Wutta Framework. If not, see <http://www.gnu.org/licenses/>. 

21# 

22################################################################################ 

23""" 

24Static Assets 

25 

26Note that (for now?) It is assumed that *all* (i.e. even custom) apps 

27will include this module somewhere during startup. For instance this 

28happens within :func:`wuttaweb.app.main()`:: 

29 

30 pyramid_config.include('wuttaweb.static') 

31 

32This allows for certain common assets to be available for all apps. 

33 

34However, an attempt is being made to incorporate Fanstatic for use 

35with the built-in static assets. It is possible the above mechanism 

36could be abandoned in the future. 

37 

38So on the Fanstatic front, we currently have defined: 

39 

40.. data:: img 

41 

42 A :class:`fanstatic:fanstatic.Library` representing the ``img`` 

43 static folder. 

44 

45.. data:: favicon 

46 

47 A :class:`fanstatic:fanstatic.Resource` representing the 

48 ``img/favicon.ico`` image file. 

49 

50.. data:: logo 

51 

52 A :class:`fanstatic:fanstatic.Resource` representing the 

53 ``img/logo.png`` image file. 

54 

55.. data:: testing 

56 

57 A :class:`fanstatic:fanstatic.Resource` representing the 

58 ``img/testing.png`` image file. 

59""" 

60 

61from fanstatic import Library, Resource 

62 

63 

64# fanstatic img library 

65img = Library('wuttaweb_img', 'img') 

66favicon = Resource(img, 'favicon.ico') 

67# nb. mock out the renderers here, to appease fanstatic 

68logo = Resource(img, 'logo.png', renderer=True) 

69testing = Resource(img, 'testing.png', renderer=True) 

70 

71 

72# TODO: should consider deprecating this? 

73def includeme(config): 

74 config.add_static_view('wuttaweb', 'wuttaweb:static')