Merge pull request #18 from StarbotDiscord/unstable

v0.1.1 Update

README.md

@@ -1,4 +1,4 @@
-# Starbot - An Open-Source Discord Bot
+# Starbot - An Open-Source Discord Bot [![Build Status](https://sydstudios.me/jenkins/job/Starbot/job/Starbot/badge/icon)](https://sydstudios.me/jenkins/job/Starbot/job/Starbot/) [![Doc Status](http://starbot.readthedocs.io/en/latest/?badge=latest)](http://starbot.readthedocs.io/en/latest/)
 
 ## Project Overview
 
@@ -14,6 +14,10 @@ If you've found a problem with Starbot, please report it to the [JIRA](https://s
 
 ## How can I contribute?
 
+### Documentation
+
+[You may read the docs here](http://starbot.readthedocs.io/en/latest/)
+
 ### Making plugins
 
 This is very easy! Go ahead and take the template below and hack it up to your hearts content. This can be in your own repo, no need to clone the bot. Third party plugins are welcomed, and the bot doesn't need any modifications to run them. Plugins would go into the `plugins` folder.
@@ -24,13 +28,15 @@ If your feeling particularly adventurous you may find working on the core of the
 
 ## Installing and running Starbot
 
+_There may be a build of the [StarBot Runtime](https://github.com/StarbotDiscord/BuildScript) available that works on your system if you're feeling adventurous._
+
 1. Make sure you have Python 3.5 or 3.6 installed, as well as git
 
-2. Run `pip install discord.py pluginbase psutil gitpython pyparsing pyspeedtest requests` in a terminal session to install the dependancies
+2. Run `pip install discord.py pluginbase psutil gitpython pyparsing pyspeedtest requests tqdm` in a terminal session to install the dependancies
 
 3. Run `git clone https://github.com/1byte2bytes/Starbot.git` to copy the code to your local system
 
 4. Run `echo [my token here] > token.txt` to create a file for the bots token
 
-5. Run `python main.py` to run the bot!
+5. Run `./run.sh` to run the bot!
 

api/bot.py

@@ -0,0 +1,4 @@
+class bot:
+    startTime = 0
+    plugins = []
+    commands = []

caching.py → api/caching.py

@@ -5,6 +5,8 @@
 import urllib
 import ssl
 
+from api import db
+
 def getCaller():
     frm = inspect.stack()[2]
     mod = inspect.getmodule(frm[0])
@@ -14,23 +16,21 @@ def getCaller():
 #=============================
 
 def writeString(string, plugin, filename):
-    with open('cache\\{}_{}'.format(plugin, filename), 'w') as f:
-        f.write(string)
+    db.cacheFileS('{}_{}'.format(plugin, filename), string)
 
 def getJson(url, caller='', customName='', save=True):
     if caller == '':
         getCaller()
     if customName == '':
         customName = url.split('/')[-1]
     fullFilename = '{}_{}'.format(caller, customName)
-    if os.path.isfile(fullFilename):
-        with open('cache/{}'.format(fullFilename)) as f:
-            return f.read()
+    cacheTry = db.getCachedFileS(fullFilename)
+    if cacheTry != '':
+        return cacheTry
     else:
         jsonString = urllib.request.urlopen(url).read().decode("utf-8")
         if save == True:
-            with open('cache/{}'.format(fullFilename), 'w') as f:
-                f.write(jsonString)
+            writeString(jsonString, caller, customName)
         return jsonString
 
 

api/db.py

@@ -1,5 +1,61 @@
 import sqlite3
 
+def cacheFile(filename, data):
+    filename = filename.replace('.', '/.')
+    conn = sqlite3.connect("bot.db3")
+    c = conn.cursor()
+    c.execute('CREATE TABLE IF NOT EXISTS cachedfiles_string (filename TEXT, data BLOB)')
+    c.execute('SELECT filename FROM cachedfiles_string WHERE filename=\'' + filename + '\'')
+    if len(list(c)) != 0:
+        c.execute('UPDATE cachedfiles_string SET data=\'?\' WHERE filename=\'?\'', (data, filename))
+    else:
+        c.execute('INSERT INTO cachedfiles_string VALUES (?,?)', ("'" + filename + "'", "'" + data + "'"))
+    conn.commit()
+    conn.close()
+
+def getCachedFile(filename):
+    conn = sqlite3.connect("bot.db3")
+    c = conn.cursor()
+    c.execute('CREATE TABLE IF NOT EXISTS cachedfiles_string (filename TEXT, data BLOB)')
+    c.execute('SELECT data FROM cachedfiles_string WHERE filename=\'' + filename + '\'')
+    try:
+        row = list(c)[0]
+    except:
+        row = [""]
+    conn.commit()
+    conn.close()
+    return row[0]
+
+def cacheFileS(filename, data):
+    conn = sqlite3.connect("bot.db3")
+    c = conn.cursor()
+    c.execute('CREATE TABLE IF NOT EXISTS cachedfiles_string (filename TEXT, data TEXT)')
+    c.execute('SELECT filename FROM cachedfiles_string WHERE filename=\'' + filename + '\'')
+    if len(list(c)) != 0:
+        c.execute('UPDATE cachedfiles_string SET data=? WHERE filename=?', (data, filename))
+    else:
+        c.execute('INSERT INTO cachedfiles_string VALUES (?,?)', (filename, data))
+    conn.commit()
+    conn.close()
+
+def getCachedFileS(filename):
+    conn = sqlite3.connect("bot.db3")
+    c = conn.cursor()
+    c.execute('CREATE TABLE IF NOT EXISTS cachedfiles_string (filename TEXT, data TEXT)')
+    c.execute('SELECT data FROM cachedfiles_string WHERE filename=\'' + filename + '\'')
+    try:
+        row = list(c)[0]
+    except:
+        print("[DB    ] Could not find file {} in string file cache.".format(filename))
+        row = [""]
+    conn.commit()
+    conn.close()
+    return row[0]
+
+#====================================
+# Prefix Stuff
+#====================================
+
 def setPrefix(serverid, prefix):
     conn = sqlite3.connect("bot.db3")
     c = conn.cursor()
@@ -25,6 +81,10 @@ def getPrefix(serverid):
     conn.close()
     return row[0]
 
+#====================================
+# Logging Stuff
+#====================================
+
 def logUserMessage(message):
     conn = sqlite3.connect("bot.db3")
     c = conn.cursor()
@@ -34,6 +94,10 @@ def logUserMessage(message):
     conn.commit()
     conn.close()
 
+#====================================
+# Server Owner Stuffs
+#====================================
+
 def isOwner(uid):
     conn = sqlite3.connect("bot.db3")
     c = conn.cursor()

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Starbot
+SOURCEDIR     = .
+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)

docs/conf.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Starbot documentation build configuration file, created by
+# sphinx-quickstart on Fri Mar 31 00:14:27 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Starbot'
+copyright = '2017, Sydney Erickson and CorpNewt'
+author = 'Sydney Erickson and CorpNewt'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- 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'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Starbotdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Starbot.tex', 'Starbot Documentation',
+     'Sydney Erickson and CorpNewt', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'starbot', 'Starbot Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Starbot', 'Starbot Documentation',
+     author, 'Starbot', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/index.rst

@@ -0,0 +1,22 @@
+.. Starbot documentation master file, created by
+   sphinx-quickstart on Fri Mar 31 00:14:27 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Starbot's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api/message <message.rst>
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`