117 changes: 59 additions & 58 deletions docs/conf.py
Expand Up @@ -11,18 +11,19 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os
import sys
import os

# 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.
#sys.path.insert(0, os.path.abspath('.'))
# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('..'))

# -- General configuration -----------------------------------------------------
# -- General configuration -----------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# 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.
Expand All @@ -35,7 +36,7 @@
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'
Expand All @@ -55,43 +56,43 @@

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# keep_warnings = False


# -- Options for HTML output ---------------------------------------------------
# -- Options for HTML output ---------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
Expand All @@ -100,26 +101,26 @@
# 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 = {}
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# html_favicon = None

# 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,
Expand All @@ -128,91 +129,91 @@

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True
# html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'indicfortunedoc'


# -- Options for LaTeX output --------------------------------------------------
# -- Options for LaTeX output --------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'indicfortune.tex', u'indicfortune Documentation',
u'Santhosh Thottingal', 'manual'),
('index', 'indicfortune.tex', u'indicfortune Documentation',
u'Santhosh Thottingal', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True
# latex_domain_indices = True


# -- Options for manual page output --------------------------------------------
# -- Options for manual page output --------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
Expand All @@ -222,31 +223,31 @@
]

# If true, show URL addresses after external links.
#man_show_urls = False
# man_show_urls = False


# -- Options for Texinfo output ------------------------------------------------
# -- 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 = [
('index', 'indicfortune', u'indicfortune Documentation',
u'Santhosh Thottingal', 'indicfortune', 'One line description of project.',
'Miscellaneous'),
('index', 'indicfortune', u'indicfortune Documentation',
u'Santhosh Thottingal', 'indicfortune', 'One line description of project.',
'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# texinfo_no_detailmenu = False
sys.path.append(os.path.abspath('_themes'))
html_theme_path = ['_themes']
html_theme = 'kr'
File renamed without changes.
7 changes: 5 additions & 2 deletions indicfortune/core.py → libindic/fortune/core.py
Expand Up @@ -18,7 +18,8 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# If you find any bugs or have any suggestions email: santhosh.thottingal@gmail.com
# If you find any bugs or have any suggestions email:
# santhosh.thottingal@gmail.com


import random
Expand All @@ -27,16 +28,18 @@


class Fortune:

"""
The fortune class. Instantiate to get access to the methods.
"""

def fortunes(self, infile, pattern=None):
""" Yield fortunes as lists of lines """
quotes = []
results = []
quote = ''
for line in infile:
#line = unicode(line)
# line = unicode(line)
if line == "%\n":
quotes.append(quote)
quote = ''
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 2 additions & 0 deletions indicfortune/expose.py → libindic/fortune/expose.py
@@ -1,7 +1,9 @@
from .core import Fortune


def indicfortune_fortune(database, pattern=None):
return Fortune().fortune(database, pattern)


def fortune():
return [indicfortune_fortune, str, str, str]
File renamed without changes.
File renamed without changes.
36 changes: 36 additions & 0 deletions libindic/fortune/tests/test_indicfortune.py
@@ -0,0 +1,36 @@
#! /usr/bin/python
# -*- coding: utf-8 -*-

from testtools import TestCase

from .. import Fortune


class IndicFortuneTest(TestCase):

def setUp(self):
super(IndicFortuneTest, self).setUp()
self.fortune = Fortune()

def test_fortune(self):
self.assertIsInstance(self.fortune.fortune("chanakya"), unicode)

def test_fortune_search(self):
self.assertIn(self.fortune.fortune("chanakya", "daughter"),
[""" Give your daughter in marriage to a good family, engage
your son in learning, see that your enemy comes to grief,
and engage your friends in dharma. (Krsna consciousness).
""",
""" Residing in a small village devoid of proper living
facilities, serving a person born of a low family,
unwholesome food, a frowning wife, a foolish son, and a
widowed daughter burn the body without fire.
""",
""" Kings speak for once, men of learning once, and the
daughter is given in marriage once. All these things
happen once and only once.
"""
])

def test_unavailable(self):
self.assertRaises(IOError, self.fortune.fortune, "randomDictionary")
11 changes: 6 additions & 5 deletions setup.cfg
@@ -1,11 +1,11 @@
[metadata]
name = indicfortune
name = libindic-fortune
author = Santhosh Thottingal
author-email = santhosh.thottingal@gmail.com
summary = Returns random quotes
license = LGPL-3.0
description-file =
README.rst
README.md
home-page = https://libindic.org/indicfortune
requires-python = >=2.7
classifier =
Expand All @@ -18,12 +18,13 @@ classifier =
Programming Language :: Python

[files]
packages =
indicfortune
namespace_packages = libindic
packages = libindic
data-files = libindic-fortune/data_files = libindic/fortune/database/*

[entry_points]
libindic.api.rest =
fortune = indicfortune.expose:fortune
fortune = libindic.fortune.expose:fortune

[wheel]
universal=1
Expand Down
1 change: 0 additions & 1 deletion setup.py
Expand Up @@ -5,4 +5,3 @@
setup_requires=['pbr'],
pbr=True
)

6 changes: 6 additions & 0 deletions test-requirements.txt
@@ -0,0 +1,6 @@
testrepository
python-subunit
flake8
mccabe
coverage
coveralls
22 changes: 0 additions & 22 deletions tests/indicfortune_test.py

This file was deleted.

18 changes: 18 additions & 0 deletions tox.ini
@@ -0,0 +1,18 @@
# Tox (http://tox.testrun.org/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions. To use it, "pip install tox"
# and then run "tox" from this directory.

[tox]
envlist = py35, py27, pep8

[testenv]
commands = {envpython} setup.py test
deps =
-rtest-requirements.txt

[testenv:pep8]
deps=
-rtest-requirements.txt
commands=
flake8 --ignore F401 libindic