news API reference¶
-
News.MAX_NEWS: Maximum number of news returned while reading news directory (int), 5
Utilities to create some news for BioMAJ
-
class
biomajmanager.news.
News
(news_dir=None, config=None, max_news=None)[source]¶ Bases:
object
Class for creating news to be displayed for BioMAJ
-
__init__
(news_dir=None, config=None, max_news=None)[source]¶ Initiate object building
Parameters: Raises: - SystemExit – If ‘news_dir’ is not a directory
- SystemExit – If ‘NEWS’ section is not defined in
manager.properties
- SystemExit – If ‘news.dir’ is not set in
manager.properties
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
biomajmanager.news.
RSS
(rss_file=None, *args, **kwargs)[source]¶ Bases:
biomajmanager.news.News
Class for generating RSS feed from news files
-
generate_rss
(rss_file=None, data=None)[source]¶ Generate RSS file from news
Parameters: - rss_file (str) – Path to file rss.xml
- data (dict data['news'] = { ... }) – Data to create RSS from
Returns: Boolean
Return type: Raises: - SystemExit – If ‘news’ key is not found in ‘data’ dict
- SystemExit – If rss file cannot be opened
-