feat(init): Initial commit of ladybug-tools-template generated files

.gitignore

@@ -0,0 +1,14 @@
+*.pyc
+test.py
+.pytest_cache
+*__pycache__
+.coverage
+*.ipynb
+.ipynb_checkpoints
+.tox
+*.egg-info
+tox.ini
+/.cache
+/.vscode
+.eggs
+*.code-workspace

.releaserc.json

@@ -0,0 +1,13 @@
+{
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/github",
+        [
+            "@semantic-release/exec",
+            {
+                "publishCmd": "bash deploy.sh"
+            }
+        ]
+    ]
+}

.travis.yml

@@ -0,0 +1,46 @@
+language: python
+
+python:
+  - "2.7"
+  - "3.6"
+
+install:
+  - pip install -r dev-requirements.txt
+  - pip install -r requirements.txt
+
+script:
+  - python -m pytest --cov=. tests/
+
+after_success:
+  - coverage report
+  - coveralls
+
+jobs:
+  include:
+  - stage: deploy
+    if: branch = master AND (NOT type IN (pull_request))
+    before_install:
+    - npm i -g [email protected]
+    python:
+    - "3.6"
+    install:
+    - pip install -r dev-requirements.txt
+    - pip install -r requirements.txt
+    - npm install @semantic-release/exec
+    script:
+    - git config --global user.email "[email protected]"
+    - git config --global user.name "ladybugbot"
+    - npx semantic-release
+  - stage: docs
+    if: branch = master AND (NOT type IN (pull_request))
+    script:
+    - sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_energy
+    - sphinx-build -b html ./docs ./docs/_build/docs
+    deploy:
+      provider: pages
+      skip_cleanup: true
+      github-token: $GH_TOKEN
+      keep-history: false
+      local_dir: docs/_build/
+      on:
+        branch: master

CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+Contributor Covenant Code of Conduct
+=========================================
+
+This project follows Ladybug Tools contributor covenant code of conduct. See our [contributor covenant code of conduct](https://github.com/ladybug-tools/contributing/blob/master/CODE-OF-CONDUCT.md).

CONTRIBUTING.md

@@ -0,0 +1,6 @@
+Contributing
+------------
+We welcome contributions from anyone, even if you are new to open source we will be happy to help you to get started. Most of the Ladybug Tools developers started learning programming through developing for Ladybug Tools.
+
+### Code contribution
+This project follows Ladybug Tools contributing guideline. See [contributing to Ladybug Tools projects](https://github.com/ladybug-tools/contributing/blob/master/README.md).

README.md

@@ -1,2 +1,48 @@
+[![Build Status](https://travis-ci.org/ladybug-tools/dragonfly-energy.svg?branch=master)](https://travis-ci.org/ladybug-tools/dragonfly-energy)
+[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-energy/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-energy)
+
+[![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
+
 # dragonfly-energy
-:dragon: :fire: Dragonfly extension for energy simulation
+
+Dragonfly extension for energy simulation.
+
+## Installation
+```console
+pip install dragonfly-energy
+```
+
+## QuickStart
+```python
+import dragonfly_energy
+
+```
+
+## [API Documentation](http://ladybug-tools.github.io/dragonfly-energy/docs)
+
+## Local Development
+1. Clone this repo locally
+```console
+git clone [email protected]:ladybug-tools/dragonfly-energy
+
+# or
+
+git clone https://github.com/ladybug-tools/dragonfly-energy
+```
+2. Install dependencies:
+```console
+cd dragonfly-energy
+pip install -r dev-requirements.txt
+pip install -r requirements.txt
+```
+
+3. Run Tests:
+```console
+python -m pytests tests/
+```
+
+4. Generate Documentation:
+```console
+sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_energy
+sphinx-build -b html ./docs ./docs/_build/docs
+```

deploy.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+echo "Building distribution"
+python setup.py sdist bdist_wheel
+echo "Pushing new version to PyPi"
+twine upload dist/* -u $PYPI_USERNAME -p $PYPI_PASSWORD

dev-requirements.txt

@@ -0,0 +1,9 @@
+coverage==4.5.2
+coveralls==1.5.1
+pytest==4.1.0
+pytest-cov==2.6.1
+Sphinx==1.8.5
+sphinx-bootstrap-theme==0.6.5
+sphinxcontrib-fulltoc==1.2.0
+sphinxcontrib-websupport==1.1.0
+twine==1.13.0

docs/README.md

@@ -0,0 +1,13 @@
+
+## Usage
+For generating the documents locally use commands below from the root folder. 
+
+```shell
+# install dependencies
+pip install Sphinx sphinxcontrib-fulltoc sphinx_bootstrap_theme
+
+# generate rst files for modules
+sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly-energy
+# build the documentation under _build/docs folder
+sphinx-build -b html ./docs ./docs/_build/docs
+```

docs/_build/.nojekyll

@@ -0,0 +1 @@
+

docs/_build/README.md

@@ -0,0 +1 @@
+# documentation

docs/_build/docs/README.md

@@ -0,0 +1 @@
+# documentation

docs/conf.py

@@ -0,0 +1,219 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains 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
+import datetime
+now = datetime.datetime.now()
+sys.path.insert(0, os.path.abspath('../'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'dragonfly-energy'
+copyright = '{}, Ladybug Tools'.format(str(now.year))
+author = 'Ladybug Tools'
+
+# The full version, including alpha/beta/rc tags
+release = ''
+
+# for example take major/minor
+version = ''
+
+# -- 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.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.imgmath',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+	'sphinxcontrib.fulltoc',
+	'sphinx.ext.napoleon'
+]
+
+# 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'
+
+# 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 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.
+#
+import sphinx_bootstrap_theme
+
+# html_theme = 'alabaster'
+html_theme = 'bootstrap'
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+# 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 = {
+    # For black navbar, do "navbar navbar-inverse"
+    'navbar_class': "navbar navbar-inverse",
+    # Fix navigation bar to top of page?
+    # Values: "true" (default) or "false"
+    'navbar_fixed_top': "true",
+	'navbar_pagenav': True,
+    'source_link_position': "nav",
+	'bootswatch_theme': "united",
+    'bootstrap_version': "3",
+	}
+
+# on_rtd is whether we are on readthedocs.org
+# on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# if not on_rtd:  # only import and set the theme if we're building docs locally
+#    import sphinx_rtd_theme
+#    html_theme = 'sphinx_rtd_theme'
+#    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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 = {
+    '**': ['localtoc.html']
+}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+
+autodoc_member_order = 'groupwise'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'lbtoolsdoc'
+
+
+# -- 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, 'dragonfly-energy.tex', 'dragonfly-energy Documentation',
+     'Ladybug Tools', '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, 'dragonfly-energy', 'dragonfly-energy 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, 'dragonfly-energy', 'dragonfly-energy Documentation',
+     author, 'dragonfly-energy', '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']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True