E-P-T · iteegi · Jun 27, 2022 · Jun 27, 2022 · Jun 27, 2022 · Jun 27, 2022
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,10 @@
+.vscode
+.idea
+.coverage
+__pycache__
+build/
+source/_templates
+source/_static
+docs/build
+rss_reader.egg-info/
+dist/
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include rss_reader/saver/to_html/templates/main.html
diff --git a/README.md b/README.md
@@ -1,28 +1,22 @@
-# How to create a PR with a homework task
 
-1. Create fork from the following repo: https://github.com/E-P-T/Homework. (Docs: https://docs.github.com/en/get-started/quickstart/fork-a-repo )
-2. Clone your forked repo in your local folder.
-3. Create separate branches for each session.Example(`session_2`, `session_3` and so on)
-4. Create folder with you First and Last name in you forked repo in the created session.
-5. Add your task into created folder
-6. Push finished session task in the appropriate branch in accordance with written above.
- You should get the structure that looks something like that
+# rss-reader
 
+## rss-reader is a command line utility that allows you to view RSS feeds 
+
+## Usage
+
+```
+> python -m rss-reader https://news.yahoo.com/rss/
 ```
- Branch: Session_2
-         DzmitryKolb
-              |___Task1.py
-              |___Task2.py
- Branch: Session_3
-         DzmitryKolb
-              |___Task1.py
-              |___Task2.py
+or:
 ```
+> rss-reader https://news.yahoo.com/rss/
+```
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
-7. When you finish your work on task you should create Pull request to the appropriate branch of the main repo https://github.com/E-P-T/Homework (Docs: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
-Please use the following instructions to prepare good description of the pull request:
-    - Pull request header should be: `Session <Number of the session> - <FirstName> <LastName>`.
-      Example: `Session 2 - Dzmitry Kolb`
-    - Pull request body: You should write here what tasks were implemented.
-      Example: `Finished: Task 1.2, Task 1.3, Task 1.6`
+Please make sure to update tests as appropriate.
 
+## License
+[MIT](https://choosealicense.com/licenses/mit/)
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'rss-reader'
+copyright = '2022, Andrey Ozerets'
+author = 'Andrey Ozerets'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
diff --git a/docs/source/display_information.rst b/docs/source/display_information.rst
@@ -0,0 +1,115 @@
+Display of information.
+=======================
+
+This part of the documentation describes how rss-reader displays information.
+-----------------------------------------------------------------------------
+
+Information display:
+--------------------
+Normally.
+~~~~~~~~~~~
+    * When all data is available.
+
+        .. figure:: /images/output.jpg
+
+    * When there is missing data.
+
+        .. figure:: /images/output-empty.jpg
+
+    * When the date parameter is used and the result contains different news sources.
+
+        .. figure:: /images/date_parametr.jpg
+
+
+With the given \-\-json parameter:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    * When all data is available.
+
+        .. code-block:: JSON
+
+            [
+                {
+                    "title_web_resource": "Yahoo News - Latest News & Headlines",
+                    "link": "https://news.yahoo.com/rss/",
+                    "items": 
+                        [
+                            {
+                                "title": "1955 warrant family seeks",
+                                "link": "https://news.yahoo.com/1955-war79.html",
+                                "pubDate": "2022-06-29T19:41:30Z",
+                                "source": "Associated Press",
+                                "content": {
+                                    "url": "https://s.yimg.com/uu/api/res/1.2/z8bf83",
+                                    "title": null
+                                }
+                            }
+                        ]
+                }
+            ]
+
+    * When there is missing data.
+
+        .. code-block:: JSON
+
+            [
+                {
+                    "title_web_resource": "Yahoo News - Latest News  Headlines",
+                    "link": "https://news.yahoo.com/rss/",
+                    "items": 
+                        [
+                            {
+                                "title": "Biden takes",
+                                "link": "",
+                                "pubDate": "2022-06-18T14:37:24Z",
+                                "source": "",
+                                "content": {
+                                    "url": "",
+                                    "title": null
+                                }
+                            }
+                        ]
+                }
+            ]
+
+
+With the given \-\-date and \-\-json parameter:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: JSON
+
+    [
+        {
+            "title_web_resource": "Yahoo News - Latest News & Headlines",
+            "link": "https://news.yahoo.com/rss/",
+            "items": 
+                [
+                    {
+                        "title": "Hong Kongs",
+                        "link": "https://news.yahoo.com/hong.html",
+                        "pubDate": "2022-06-01",
+                        "source": "Associated Press",
+                        "content": {
+                            "url": "https://s.yimg.com/uu/api/reen/ap.org/0c",
+                            "title": null
+                        }
+                    }
+                ]
+        },
+        {
+            "title_web_resource": "Новости ООН - Здравоохранение",
+            "link": "https://news.un.org/feed/rss.xml",
+            "items": 
+                [
+                    {
+                        "title": "ВОЗ: необходимы антибиотики нового поколения",
+                        "link": "https://news.un.org/08.html",
+                        "pubDate": "2022-06-01",
+                        "source": "Associated Press",
+                        "content": {
+                        "url": "https://s.yimg.com/uu/api-rg/0725fc",
+                        "title": null
+                        }
+                    }
+                ]
+        }
+    ]
diff --git a/docs/source/images/date_parametr.jpg b/docs/source/images/date_parametr.jpg
diff --git a/docs/source/images/local_storage.jpg b/docs/source/images/local_storage.jpg
diff --git a/docs/source/images/output-empty.jpg b/docs/source/images/output-empty.jpg
diff --git a/docs/source/images/output.jpg b/docs/source/images/output.jpg
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,27 @@
+.. rss-reader documentation master file, created by
+   sphinx-quickstart on Sun Jun 26 12:48:42 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to rss-reader's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   start_program.rst
+   display_information.rst
+   local_storage.rst
+   to_html_mode.rst
+   to_pdf_mode.rst
+   tests.rst
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/local_storage.rst b/docs/source/local_storage.rst
@@ -0,0 +1,11 @@
+Local storage.
+=======================
+
+This part of the documentation describes how rss-reader stores local information.
+---------------------------------------------------------------------------------
+
+All information is stored in 'home directory'/.rss-reader/local_storage.csv
+
+Representation of the local storage file.
+
+.. figure:: /images/local_storage.jpg
diff --git a/docs/source/start_program.rst b/docs/source/start_program.rst
@@ -0,0 +1,17 @@
+Program launch
+==============
+
+This part of the documentation describes how to run rss-reader.
+---------------------------------------------------------------
+
+To start rss-reader, just run this simple command in the terminal of your choice::
+
+    $ python -m rss_reader
+
+The program supports the following keys:
+    * source - RSS URL. Required argument.
+    * \-\-verbose - Outputs verbose status messages.a
+    * \-\-json - Print result as JSON in stdout.
+    * \-\-limit - Limit news topics if this parameter provided.
+    * \-\-version - Print version info.
+    * \-\-date - Search for news on a specified date. Date in the format Y-m-d (for example: 20191206).
diff --git a/docs/source/tests.rst b/docs/source/tests.rst
@@ -0,0 +1,14 @@
+Program testing.
+================
+
+This part of the documentation describes how to test the rss-reader.
+--------------------------------------------------------------------
+
+To start testing just run the following code::
+
+    $ python -m pytest
+
+For reference:
+
+* Each package contains its own tests.
+* Integration tests are collected in the rss_reader\tests package.
diff --git a/docs/source/to_html_mode.rst b/docs/source/to_html_mode.rst
@@ -0,0 +1,14 @@
+Mode for saving work results to an HTML file.
+=============================================
+
+This part of the documentation describes how to save the results of your work in a HTML file.
+---------------------------------------------------------------------------------------------
+
+You can start this mode::
+
+    $ rss_reader https://rss.nytimes.com/services/xml/rss/nyt/World.xml --to-html D:\
+
+The file will be saved as news.html.
+
+The save handler in the html file is called through the chain pattern, and the specific way
+the file is generated is determined through the strategy pattern.
diff --git a/docs/source/to_pdf_mode.rst b/docs/source/to_pdf_mode.rst
@@ -0,0 +1,14 @@
+Mode for saving work results to an PDF file.
+=============================================
+
+This part of the documentation describes how to save the results of your work in a PDF file.
+---------------------------------------------------------------------------------------------
+
+You can start this mode::
+
+    $ rss_reader https://rss.nytimes.com/services/xml/rss/nyt/World.xml --to-pdf D:\
+
+The file will be saved as news.pdf.
+
+The save handler in the PDF file is called by the chain template.
+Temporary files are stored in the user's directory and are deleted after saving the PDF file.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		include rss_reader/saver/to_html/templates/main.html