Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

initial commit

  • Loading branch information...
commit ce7eebc300e771f555e51db602a9ad698eceec2f 0 parents
@reedobrien reedobrien authored
7 CHANGES.txt
@@ -0,0 +1,7 @@
+lumin Changelog
+==========================
+
+0.0 (unreleased)
+----------------
+
+- Initial release.
2  COPYRIGHT.txt
@@ -0,0 +1,2 @@
+Copyright (c) 2010 Koansys, LLC and Contributors.
+(http://koansys.com), All Rights Reserved
41 LICENSE.txt
@@ -0,0 +1,41 @@
+License
+
+ A copyright notice accompanies this license document that identifies
+ the copyright holders.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are
+ met:
+
+ 1. Redistributions in source code must retain the accompanying
+ copyright notice, this list of conditions, and the following
+ disclaimer.
+
+ 2. Redistributions in binary form must reproduce the accompanying
+ copyright notice, this list of conditions, and the following
+ disclaimer in the documentation and/or other materials provided
+ with the distribution.
+
+ 3. Names of the copyright holders must not be used to endorse or
+ promote products derived from this software without prior
+ written permission from the copyright holders.
+
+ 4. If any files are modified, you must cause the modified files to
+ carry prominent notices stating that you changed the files and
+ the date of any change.
+
+ Disclaimer
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND
+ ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+ TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ SUCH DAMAGE.
+
4 README.txt
@@ -0,0 +1,4 @@
+lumin
+================
+
+Please see docs/index.rst for the documentation.
22 docs/.static/koansys.css
@@ -0,0 +1,22 @@
+@import url('default.css');
+body {
+ background-color: #94bd5e;
+}
+
+div.document {
+ background-color: #dad3bd;
+}
+
+div.sphinxsidebar h3, h4, h5, a {
+ color: #333366 !important;
+}
+
+div.related {
+ color: highlight !important;
+ background-color: #597138;
+}
+
+div.related a {
+ color: highlight !important;
+}
+
BIN  docs/.static/koansyslogo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 docs/Makefile
@@ -0,0 +1,70 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " pickle to make pickle files (usable by e.g. sphinx-web)"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview over all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+
+clean:
+ -rm -rf .build/*
+
+html:
+ mkdir -p .build/html .build/doctrees
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
+ @echo
+ @echo "Build finished. The HTML pages are in .build/html."
+
+pickle:
+ mkdir -p .build/pickle .build/doctrees
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files or run"
+ @echo " sphinx-web .build/pickle"
+ @echo "to start the sphinx-web server."
+
+web: pickle
+
+htmlhelp:
+ mkdir -p .build/htmlhelp .build/doctrees
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in .build/htmlhelp."
+
+latex:
+ mkdir -p .build/latex .build/doctrees
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in .build/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ mkdir -p .build/changes .build/doctrees
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
+ @echo
+ @echo "The overview file is in .build/changes."
+
+linkcheck:
+ mkdir -p .build/linkcheck .build/doctrees
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in .build/linkcheck/output.txt."
14 docs/api.rst
@@ -0,0 +1,14 @@
+API Documentation for lumin
+======================================
+
+Interfaces
+----------
+
+Document interfaces here. You may want to use the ``.. autointerface::``
+directive provided by :mod:`repoze.sphinx.autointerface`, in which case
+you will need to add it to the extensions in `conf.py`.
+
+Exceptions
+----------
+
+Document any custom exceptions here.
185 docs/conf.py
@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+#
+# lumin documentation build configuration file
+#
+# This file is execfile()d with the current directory set to its containing
+# dir.
+#
+# The contents of this file are pickled, so don't put values in the
+# namespace that aren't pickleable (module imports are okay, they're
+# removed automatically).
+#
+# All configuration values have a default value; values that are commented
+# out serve to show the default value.
+
+import sys, os
+
+# If your extensions are in another directory, add it here. If the
+# directory is relative to the documentation root, use os.path.abspath to
+# make it absolute, like shown here.
+#sys.path.append(os.path.abspath('some/directory'))
+
+# 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']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General substitutions.
+project = 'lumin'
+copyright = '2009, Koansys, LLC <info@koansys.com>'
+
+# The default replacements for |version| and |release|, also used in various
+# other places throughout the built documents.
+#
+# The short X.Y version.
+version = '0.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.0'
+
+# There are two options for replacing |today|: either, you set today to
+# some non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directories, that shouldn't be
+# searched for source files.
+#exclude_dirs = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#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
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'koansys.css'
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as
+# html_title.
+#html_short_title = None
+
+# The name of an image file (within the static path) to place at the top of
+# the sidebar.
+html_logo = '.static/koansyslogo.png'
+
+# 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
+
+# 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']
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, the reST sources are included in the HTML build as
+# _sources/<name>.
+#html_copy_source = 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 = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'lumindoc'
+
+
+# Options for LaTeX output
+# ------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, document class [howto/manual]).
+latex_documents = [
+ ('index', 'lumin.tex', 'lumin Documentation',
+ 'Koansys', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the
+# top of the title page.
+latex_logo = '.static/koansyslogo.png'
+
+# For "manual" documents, if this is true, then toplevel headings are
+# parts, not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
24 docs/index.rst
@@ -0,0 +1,24 @@
+Documentation for lumin
+==================================
+
+Put the overview of the purpose of the package here.
+
+
+.. toctree::
+ :maxdepth: 2
+
+ api.rst
+
+
+Topic A
+-------
+
+Explain topic.
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
37 lumin/__init__.py
@@ -0,0 +1,37 @@
+import re
+import unicodedata
+
+from pymongo.errors import DuplicateKeyError
+
+def insert_doc(collection, document, key='url_id', safe=True):
+ """
+ TODO: Insert a doc with a suffixed id if necessary as our unique id, and return
+ TODO: prolly not ready for use yet. I just put a sanitized copy of this here.
+ TODO: but it needs more though.
+ """
+ suffix = 1
+ url_id = document[key]
+ while True:
+ ## TODO: possible perfomance penalty
+ ## If there are many of a given duplicate id
+ ## this will me an expensive loop. otherwise no big
+ ## deal.
+ ## TODO: add to api docs
+ try:
+ collection.ensure_index(key, unique=True)
+ oid = collection.insert(document, safe=safe)
+ return url_id
+ except DuplicateKeyError, e:
+ url_id_suffixed = u','.join([url_id,
+ unicode(suffix)])
+ document[key] = url_id_suffixed
+ suffix+=1
+ return url_id_suffixed
+
+def normalize(title):
+ """
+ make url ready string/id from a title
+ """
+ url_safe = unicodedata.normalize('NFKD', title).encode('ascii', 'ignore')
+ url_safe = unicode(re.sub('[^\w\s-]', '', url_safe).strip().lower())
+ return re.sub('[-\s]+', '-', url_safe)
40 lumin/son.py
@@ -0,0 +1,40 @@
+from pymongo.son_manipulator import SONManipulator
+
+import colander
+
+class ColanderNullTransformer(SONManipulator):
+ """Added to the db at load time in (at the time of this writing)
+ run:get_root
+ This allows MongoDB to store and retrieve colander.null sentinals for
+ unknown values.
+ """
+ def transform_incoming(self, son, collection):
+ for (k, v) in son.items():
+ if v is colander.null:
+ son[k] = {'_type': 'colander.null'}
+ continue
+ if isinstance(v, dict):
+ self.recursive_in(v)
+ return son
+
+ def transform_outgoing(self, son, collection):
+ for (k, v) in son.items():
+ if isinstance(v, dict):
+ self.recursive_out(v)
+ return son
+
+ def recursive_in(self, subson):
+ for (k, v) in subson.items():
+ if v is colander.null:
+ subson[k] = {'_type': 'colander.null'}
+ continue
+ if isinstance(v, dict):
+ for (key, value) in v.items():
+ self.recursive_in(value)
+
+ def recursive_out(self, subson):
+ for (k, v) in subson.items():
+ if isinstance(v, dict):
+ if "_type" in v and v['_type'] == 'colander.null':
+ subson[k] = colander.null
+ self.recursive_out(v)
115 setup.py
@@ -0,0 +1,115 @@
+##############################################################################
+#
+# Copyright (c) 2010 Koansys, LLC..
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the BSD-like license at
+# http://www.koansys.org/LICENSE.txt. A copy of the license should accompany
+# this distribution. THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL
+# EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND
+# FITNESS FOR A PARTICULAR PURPOSE
+#
+##############################################################################
+
+import os
+try:
+ import subprocess
+ has_subprocess = True
+except:
+ has_subprocess = False
+
+from distutils.cmd import Command
+
+from setuptools import setup
+from setuptools import find_packages
+
+here = os.path.abspath(os.path.dirname(__file__))
+README = open(os.path.join(here, 'README.txt')).read()
+CHANGES = open(os.path.join(here, 'CHANGES.txt')).read()
+
+__version__ = '0.0.0'
+
+requires = ['nose',
+ 'coverage',
+ 'colander',
+ 'repoze.bfg'
+ ]
+
+class doc(Command):
+ description = "generate or test documentation"
+ user_options = [("test", "t",
+ "run doctests instead of generating documentation")]
+ boolean_options = ["test"]
+
+ def initialize_options(self):
+ self.test = False
+
+ def finalize_options(self):
+ pass
+
+ def run(self):
+ if self.test:
+ path = "doc/_build/doctest"
+ mode = "doctest"
+ else:
+ path = "doc/_build/%s" % __version__
+ mode = "html"
+
+ # shutil.rmtree("doc/_build", ignore_errors=True)
+ try:
+ os.makedirs(path)
+ except:
+ pass
+
+ if has_subprocess:
+ status = subprocess.call(["sphinx-build", "-b", mode, "doc", path])
+
+ if status:
+ raise RuntimeError("documentation step '%s' failed" % mode)
+
+ print ""
+ print "Documentation step '%s' performed, results here:" % mode
+ print " %s/" % path
+ else:
+ print """
+`setup.py doc` is not supported for this version of Python.
+
+Please ask in the user forums for help.
+"""
+
+setup(name='lumin',
+ version=__version__,
+ description='A library to aid in using MongoDB with repoze.bfg',
+ long_description=README + '\n\n' + CHANGES,
+ classifiers=[
+ "Topic :: Database",
+ "Development Status :: 3 - Alpha",
+ "Framework :: BFG",
+ "Intended Audience :: Developers",
+ "License :: OSI Approved :: BSD License",
+ "Programming Language :: Python",
+ "Topic :: Software Development :: Libraries",
+ "Topic :: Utilities",
+ ],
+ keywords='',
+ author="Koansys, LLC",
+ author_email="info@koansys.org",
+ url="http://koansys.org",
+ license="BSD-derived (http://koansys.org/LICENSE.txt)",
+ packages=find_packages(),
+ include_package_data=True,
+ zip_safe=False,
+ tests_require = requires,
+ install_requires = requires,
+ test_suite="nose.collector",
+ cmdclass = {'doc' : doc },
+ entry_points = """\
+ #[console_scripts]
+ #addzope2user = lumin.scripts.adduser:main
+
+ #[paste.filter_app_factory]
+ #middleware = lumin:constructor
+ """
+ )
+
Please sign in to comment.
Something went wrong with that request. Please try again.