-----------------------------------------------------------------------------
# CNN Headlines Module v1.1 by Smooth.ACiDic
-----------------------------------------------------------------------------

author: Lawrence Manuel aka Smooth
release date: October 13, 2017
BBS Software: Mystic BBS Software v1.12+

type:   [ ] MPL
        [ ] MPY (Mystic Python Script)
        [x] PY (Python Script)
        [ ] Pascal
        [ ] Other

os:     [x] Windows
        [x] MacOS
        [x] Linux

-----------------------------------------------------------------------------
## Installation Guide
-----------------------------------------------------------------------------

Note:
This custom Python module was made for Python 2.7+.  Your system must have
Python 2.7+ and not 3.0+ to run.

-----------------------------------------------------------------------------

Prerequisites:
Prior to installing this custom Python module into your Mystic BBS Software
directory.  Be sure to install any missing Python modules.  This package
requires:

    * os (already installed with Python)
    * ConfigParser
    * xmltodict
    * urllib
    * datetime
    * textwrap

Windows:
Go to your command shell by executing 'cmd' from your run prompt. (Window + R).
Once you're at the command prompt enter 'pip install' + missing module(s).

example:   pip install ConfigParser
           pip install xmltodict
           pip install urllib
           pip install datetime
           pip install textwrap

Macintosh/Linux:
Go to your terminal and installing the missing modules using 'sudo pip install'.

example:    sudo pip install ConfigParser
            sudo pip install xmltodict
            sudo pip install urllib
            sudo pip install datetime
            sudo pip install textwrap

-----------------------------------------------------------------------------
## Module Installation Steps
-----------------------------------------------------------------------------

Step 1:
Windows:
After installing all of the missing Python modules.  You can then copy the
files 'sm-cnn-headlines.cfg' and 'sm-cnn-headlines.py' to a common python
file directory for all of your Mystic BBS python mods.  I have mines in
'c:\mystic\python'.

Macintosh and Linux:
After installing all of the missing Python modules.  You can then copy the
files 'sm-cnn-headlines.cfg' and 'sm-cnn-headlines.py' to a common python
file directory for all of your Mystic BBS python mods.  I have mines in
'/mystic/python'.

Note: Be sure to give execution and write access on the 'sm-cnn-headlines.py'.

Step 2:
Modify the settings in 'sm-cnn-headlines.cfg'.  There are only two
settings.  One for your BBS Name and the other for the desired file name
and directory where it will be generated.

bbsName: My BBS (default setting)
bbsName: iNK TWO BBS (change to your bbs name)

Windows:
outputFileName: c:\mystic\text\bullet2.ans (default)
outputFileName: c:\mystic\text\cnn-news.ans (change to whatever
                filename you'd like it to display as)

Macintosh/Linux:
outputFileName: /mystic/text/bullet2.ans (default)
outputFileName: /mystic/text/cnn-news.ans (change to whatever
                filename you'd like it to display as)

Step 3 (testing it):
You can test to see if it works for you by going to the location
of your Python file (sm-cnn-headlines.py) and running the command
line entry of:

python sm-cnn-headlines.py

If you find the new file you specified in the directory that you
designated in the config file (sm-cnn-headlines.cfg) then you've
set everything up correctly.  The last step is to set things up in
Mystic BBS Software.

-----------------------------------------------------------------------------
# Mystic BBS Software Configuration
-----------------------------------------------------------------------------

Step 1 (To Generate File):

    option 1 (Event Editor)

    Windows:
    * Add a new event
    * Modify settings
    * Active (Yes)
    * Description (CNN Headlines)
    * Exec Type (Interval)
    * Exec Hour / Min (You decide when you want this to run)
    * Shell (python c:\mystic\python\sm-cnn-headlines.py)

    Windows:
    * Add a new event
    * Modify settings
    * Active (Yes)
    * Description (CNN Headlines)
    * Exec Type (Interval)
    * Exec Hour / Min (You decide when you want this to run)
    * Shell (python /mystic/python/sm-cnn-headlines.py)

Step 2 (To Display File):

    option 1 (Bulletin File)
    * If you name it bullet(1-??).ans (example: bullet2.ans) you can display
    it from your bulletin menu by selecting the number of your bulletin.

    option 2 (Menu)
    * Add a new menu item.
    * Edit that menu item.
    * Click [Tab] to Edit 'menu commands'
    * Add 3 entries

    command:(GD) Display a file (data: topaz) - turn on amiga font
    command:(GD) Display a file (data: cnnnews) - display cnn news
    command:(GD) Display a file (data: codepage) - return back to cp437 font

-----------------------------------------------------------------------------

## Module Support

If you run into any problems in executing or in the installation of this
module you can contact me at: smooth@inktwo.com

-----------------------------------------------------------------------------