🥚 🎡 0.0.1 release

CLiu13 · CLiu13 · commit 62e5f710ddf2 · 2018-12-31T12:22:23.000-05:00
Closes moremoban/moban#54
diff --git a/.gitignore b/.gitignore
diff --git a/.moban.d/CUSTOM_README.rst.jj2 b/.moban.d/CUSTOM_README.rst.jj2
@@ -0,0 +1,9 @@
+{% extends 'README.rst.jj2' %}
+
+{%block documentation_link%}
+{%endblock%}
+
+{%block features%}
+With `slimish-jinja2 for Python 3 <git+https://github.com/cliu13/slimish-jinja2@python3>`_, this library allow moban users to
+have slim template in their next documentation endeavour. 
+{%endblock%}
diff --git a/.moban.d/custom_setup.py.jj2 b/.moban.d/custom_setup.py.jj2
@@ -0,0 +1,7 @@
+{% extends "setup.py.jj2" %}
+
+{%block platform_block%}
+{%endblock%}
+
+
+{%block morefiles %} 'CONTRIBUTORS.rst',{%endblock%}
diff --git a/.moban.d/tests/custom_requirements.txt.jj2 b/.moban.d/tests/custom_requirements.txt.jj2
@@ -0,0 +1,7 @@
+{% extends "tests/requirements.txt.jj2" %}
+
+{%block extras %}
+moban
+black;python_version>="3.6"
+isort;python_version>="3.6"
+{%endblock%}
diff --git a/.moban.yml b/.moban.yml
@@ -0,0 +1,18 @@
+requires:
+  - pypi-mobans-pkg==0.0.2
+configuration:
+  template_dir:
+  - "pypi-mobans-pkg:templates"
+  - ".moban.d"
+  configuration: moban-slim.yml
+targets:
+  - README.rst: CUSTOM_README.rst.jj2
+  - setup.py: custom_setup.py.jj2
+  - requirements.txt: requirements.txt.jj2
+  - "tests/requirements.txt": "tests/custom_requirements.txt.jj2"
+  - "docs/source/conf.py": "docs/conf.py_t"
+  - test.sh: test.script.jj2
+  - "moban_slim/_version.py": "_version.py.jj2"
+  - .gitignore: gitignore.jj2
+  - .travis.yml: travis.yml.jj2
+  - Pipfile: Pipfile.jj2
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,23 @@
+sudo: false
+language: python
+notifications:
+  email: false
+python:
+  - pypy-5.3.1
+  - 3.7-dev
+  - 3.6
+  - 3.5
+  - 3.4
+  - 2.7
+before_install:
+  - if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install flake8==2.6.2; fi
+  - if [[ -f min_requirements.txt && "$MINREQ" -eq 1 ]]; then
+      mv min_requirements.txt requirements.txt ;
+    fi
+  - test ! -f rnd_requirements.txt || pip install --no-deps -r rnd_requirements.txt
+  - test ! -f rnd_requirements.txt || pip install -r rnd_requirements.txt ;
+  - pip install -r tests/requirements.txt
+script:
+  - make test
+after_success:
+  codecov
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -0,0 +1,2 @@
+Change log
+===========
diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst
@@ -0,0 +1,13 @@
+Author
+================================================================================
+
+Charlie Liu
+
+Contributors
+================================================================================
+
+In alphabetical order:
+
+* `C. W. <https://github.com/chfw>`_
+* `John Vandenberg <https://github.com/jayvdb>`_
+* `PRAJWAL M <https://github.com/PrajwalM2212>`_
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,3 @@
+include README.rst
+include CHANGELOG.rst
+include CONTRIBUTORS.rst
diff --git a/Makefile b/Makefile
@@ -0,0 +1,12 @@
+all: test
+
+test:
+	bash test.sh
+
+document:
+	bash document.sh
+
+format:
+	isort -y $(find moban_slim -name "*.py"|xargs echo) $(find tests -name "*.py"|xargs echo)
+	black -l 79 moban_slim
+	black -l 79 tests
diff --git a/Pipfile b/Pipfile
@@ -0,0 +1,11 @@
+[[source]]
+url = 'https://pypi.python.org/simple'
+verify_ssl = true
+name = 'pypi'
+
+[requires]
+python_version= '3.6'
+
+[packages]
+    git+https://github.com/cliu13/slimish-jinja2@python3
+    lml>=0.0.7
diff --git a/README.rst b/README.rst
@@ -0,0 +1,33 @@
+================================================================================
+moban-slim
+================================================================================
+
+.. image:: https://api.travis-ci.org/moremoban/moban-slim.svg
+   :target: http://travis-ci.org/moremoban/moban-slim
+
+.. image:: https://codecov.io/github/moremoban/moban-slim/coverage.png
+   :target: https://codecov.io/github/moremoban/moban-slim
+
+
+
+With `slimish-jinja2 for Python 3 <git+https://github.com/cliu13/slimish-jinja2@python3>`_, this library allow moban users to
+have slim template in their next documentation endeavour. 
+
+Installation
+================================================================================
+
+
+You can install moban-slim via pip:
+
+.. code-block:: bash
+
+    $ pip install moban-slim
+
+
+or clone it and install it:
+
+.. code-block:: bash
+
+    $ git clone https://github.com/moremoban/moban-slim.git
+    $ cd moban-slim
+    $ python setup.py install
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 = u''
+copyright = u''
+author = u''
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u''
+
+
+# -- 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 = []
+
+# 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 = ''
+
+# The master toctree document.
+master_doc = ''
+
+# 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 = ''
+
+# 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 = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'doc'
+
+
+# -- 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, '.tex', u'',
+     u'', '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, '', u'',
+     [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, '', u'',
+     author, '', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
diff --git a/moban-slim.yml b/moban-slim.yml
@@ -0,0 +1,14 @@
+name: "moban-slim"
+organisation: "moremoban"
+author: "Charlie Liu, C.W et al"
+contact: "wangc_2011@hotmail.com"
+company: "Moremoban members and its contributors"
+version: "0.0.1dev"
+current_version: "0.0.1dev"
+release: "0.0.1dev"
+copyright_year: 2018
+license: MIT
+dependencies:
+  - git+https://github.com/cliu13/slimish-jinja2@python3
+  - lml>=0.0.7
+description: "Provide slim templating capability to moban."
diff --git a/moban_slim/__init__.py b/moban_slim/__init__.py
@@ -0,0 +1,15 @@
+# flake8: noqa
+from moban_slim._version import __version__
+from moban_slim._version import __author__
+
+from lml.plugin import PluginInfo, PluginInfoChain
+import moban.constants as constants
+
+
+PluginInfoChain(__name__).add_a_plugin_instance(
+    PluginInfo(
+        constants.TEMPLATE_ENGINE_EXTENSION,
+        "%s.engine.EngineSlim" % __name__,
+        tags=["slim"],
+    )
+)
diff --git a/moban_slim/_version.py b/moban_slim/_version.py
@@ -0,0 +1,2 @@
+__version__ = "0.0.1dev"
+__author__ = "Charlie Liu, C.W et al"
diff --git a/moban_slim/engine.py b/moban_slim/engine.py
@@ -0,0 +1,23 @@
+import codecs
+
+from jinja2 import Environment, FileSystemLoader
+from slimish_jinja import SlimishExtension
+import moban.utils as utils
+
+
+class EngineSlim(object):
+    def __init__(self, template_dirs):
+        self.template_dirs = template_dirs
+        self.jj2_env = Environment(
+            loader=FileSystemLoader(template_dirs),
+            extensions=[SlimishExtension]
+        )
+        self.jj2_env.slim_debug = True
+
+    def get_template(self, template_file):
+        template = self.jj2_env.get_template(template_file)
+        return template
+
+    def apply_template(self, template, data, _):
+        rendered_content = template.render(**data)
+        return rendered_content
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+git+https://github.com/cliu13/slimish-jinja2@python3
+lml>=0.0.7
diff --git a/rnd_requirements.txt b/rnd_requirements.txt
@@ -0,0 +1 @@
+https://github.com/moremoban/moban/archive/dev.zip
diff --git a/run_nose.py b/run_nose.py
@@ -0,0 +1,2 @@
+import nose
+nose.run()
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal = 1
diff --git a/setup.py b/setup.py
diff --git a/test.sh b/test.sh
diff --git a/tests/fixtures/slim_tests/expected_output.txt b/tests/fixtures/slim_tests/expected_output.txt
diff --git a/tests/fixtures/slim_tests/file_tests.json b/tests/fixtures/slim_tests/file_tests.json
diff --git a/tests/fixtures/slim_tests/file_tests.slim b/tests/fixtures/slim_tests/file_tests.slim
diff --git a/tests/requirements.txt b/tests/requirements.txt
diff --git a/tests/test_slim_engine.py b/tests/test_slim_engine.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+include README.rst`
	`2`	`+include CHANGELOG.rst`
	`3`	`+include CONTRIBUTORS.rst`