Merge branch 'develop' into feature/defaults

.gitignore

@@ -1,3 +1,4 @@
+tags
 *~
 *.pyc
 .DS_Store

.travis.yml

@@ -9,9 +9,6 @@ env:
 matrix:
   include:
   # Linux, not on master
-  - if: branch != master
-    os: linux
-    env: TRAVIS_PYTHON_VERSION=2.7 NUMPY=True
   - if: branch != master
     os: linux
     env: TRAVIS_PYTHON_VERSION=3.7 NUMPY=True
@@ -28,20 +25,14 @@ matrix:
       - pip install pytest-cov codecov black
     script:
       - black --check --exclude venv .
-      - py.test ./eppy/tests --cov=./ -v
+      - py.test ./tests --cov=./ -v
     after_success:
       # coverage reporting on CodeCov
       - codecov
   # Linux, on master
-  - if: branch = master
-    os: linux
-    env: TRAVIS_PYTHON_VERSION=2.7
   - if: branch = master
     os: linux
     env: TRAVIS_PYTHON_VERSION=3.7
-  - if: branch = master
-    os: linux
-    env: TRAVIS_PYTHON_VERSION=2.7 NUMPY=True
   - if: branch = master
     os: linux
     env: TRAVIS_PYTHON_VERSION=3.7 NUMPY=True
@@ -58,27 +49,18 @@ matrix:
       - pip install pytest-cov codecov black
     script:
       - black --check --exclude venv .
-      - py.test ./eppy/tests --cov=./ -v
+      - py.test ./tests --cov=./ -v
     after_success:
       # coverage reporting on CodeCov
       - codecov
   # OSX, not on master
-  - if: branch != master
-    os: osx
-    env: TRAVIS_PYTHON_VERSION=2.7 NUMPY=True
   - if: branch != master
     os: osx
     env: TRAVIS_PYTHON_VERSION=3.7 NUMPY=True
   #   OSX, on master
-  - if: branch = master
-    os: osx
-    env: TRAVIS_PYTHON_VERSION=2.7
   - if: branch = master
     os: osx
     env: TRAVIS_PYTHON_VERSION=3.7
-  - if: branch = master
-    os: osx
-    env: TRAVIS_PYTHON_VERSION=2.7 NUMPY=True
   - if: branch = master
     os: osx
     env: TRAVIS_PYTHON_VERSION=3.7 NUMPY=True
@@ -128,4 +110,4 @@ install:
   - pip install pytest
 
 script:
-  - py.test ./eppy/tests
+  - py.test ./tests

CONTRIBUTING.rst

@@ -0,0 +1,128 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/santoshphilip/eppy/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+eppy could always use more documentation, whether as part of the
+official eppy docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/santoshphilip/eppy/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `eppy` for local development.
+
+1. Fork the `eppy` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone [email protected]:your_name_here/eppy.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv eppy
+    $ cd eppy/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ flake8 eppy tests
+    $ python setup.py test or pytest
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
+   https://travis-ci.com/santoshphilip/eppy/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ pytest tests.test_eppy
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.

docs/source/changes.rst → HISTORY.rst

@@ -1,9 +1,89 @@
+=======
 History
 =======
 
 Changes
 ~~~~~~~
 
+2020-09-03
+----------
+
+- Partial fix for #287 (deprecate python2)
+    - removed six in most places
+    - removed python2 in .travis.yml
+    - removed python2 in appveyor.yml
+
+
+2020-06-20
+----------
+
+- fixed issue #291
+    - used cookiecutter template for eppy
+    - from https://github.com/cookiecutter/cookiecutter
+- eases development, because the following commands are available from ``make``::
+    
+    clean                remove all build, test, coverage and Python artifacts
+    clean-build          remove build artifacts
+    clean-pyc            remove Python file artifacts
+    clean-test           remove test and coverage artifacts
+    lint                 check style with flake8
+    test                 run tests quickly with the default Python
+    test-all             run tests on every Python version with tox
+    coverage             check code coverage quickly with the default Python
+    docs                 generate Sphinx HTML documentation, including API docs
+    servedocs            compile the docs watching for changes
+    release              package and upload a release
+    dist                 builds source and wheel package
+    install              install the package to the active Python's site-packages
+    
+
+2020-06-13
+----------
+
+- fixed issue #289    
+    - Problem: E+ is unable to read numbers that are wider than 19 digits
+    - Solution: format these numbers in scientific notation
+
+2020-06-07
+----------
+
+- fixed issue #281
+    - Problem: pytest failing in python 2
+    - Solution: Set the correct version numbers in the requirements.txt file
+
+2020-06-05
+----------
+
+- fixed issue # 283
+    - surface.azimuth calculates the azimuth from the surface coordinates
+    - surface.true_azimuth also include the effecto building azimuth ans zone azimuth
+
+
+
+
+release r0.5.52
+~~~~~~~~~~~~~~~
+
+2019-09-14
+----------
+
+- fixed issue #245 
+    - Error handling errors in python 3
+
+2019-08-17
+----------
+
+- fixed issue #254 
+   - when running a simulation:
+       - Add expandobjects flag if any HVACTemplate objects are present in IDF
+
+2019-08-03
+----------
+
+- fixed issue #251
+    - Run black on the whole codebase.
+    - Added black --check . to the Travis config for Python 3.7 on linux for master and non-master branches, to fail if formatting inconsistencies are found.
+
 release r0.5.51
 ~~~~~~~~~~~~~~~
 

MANIFEST.in

@@ -0,0 +1,11 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

README.md → README.rst

@@ -1,17 +1,22 @@
-Eppy
 ====
-[![PyPI](https://img.shields.io/pypi/dm/eppy.svg)](https://pypi.python.org/pypi/eppy)
- from PyPI
+eppy
+====
+
+
+.. image:: https://img.shields.io/pypi/v/eppy.svg
+        :target: https://pypi.python.org/pypi/eppy
+
+.. image:: https://img.shields.io/travis/santoshphilip/eppy.svg
+        :target: https://travis-ci.com/santoshphilip/eppy
 
-[![Travis](https://img.shields.io/travis/santoshphilip/eppy/master.svg)](https://travis-ci.org/santoshphilip/eppy)
- for Python 2.7 and 3.5 on Linux and OSX via Travis
+.. image:: https://readthedocs.org/projects/eppy/badge/?version=latest
+        :target: https://eppy.readthedocs.io/en/latest/?badge=latest
+        :alt: Documentation Status
 
-[![Appveyor](https://img.shields.io/appveyor/ci/santoshphilip/eppy/master.svg)](https://ci.appveyor.com/api/projects/status/github/santoshphilip/eppy)
- for Python 2.7 and 3.5 on Windows via Appveyor
 
-[![CodeCov](https://img.shields.io/codecov/c/github/santoshphilip/eppy/master.svg)](https://codecov.io/github/santoshphilip/eppy)
- via CodeCov
 
+
+scripting language for E+, Energyplus
 Eppy is a scripting language for EnergyPlus idf files, and EnergyPlus output files. Eppy is written in the programming language Python. As a result it takes full advantage of the rich data structure and idioms that are available in Python. You can programmatically navigate, search, and modify EnergyPlus idf files using eppy. The power of using a scripting language allows you to do the following:
 
 - Make a large number of changes in an idf file with a few lines of eppy code.
@@ -40,3 +45,10 @@ The documentation is at:
 to get a quick sense of how it feels to use eppy, take a look at
 <http://eppy.readthedocs.io/en/latest/Main_Tutorial.html>
 
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage