Merge pull request #3 from Myoldmopar/PolishingAgain

Rename source dir to energyplus_api_helpers

.github/workflows/flake8.yml

@@ -18,4 +18,4 @@ jobs:
       run: pip install flake8
 
     - name: Run Flake8
-      run: flake8 eplus_api_helpers
+      run: flake8 energyplus_api_helpers

.github/workflows/test.yml

@@ -44,12 +44,12 @@ jobs:
       - name: Extract EnergyPlus
         run: ${{ matrix.extract_command }} "energyplus${{ matrix.file_extension }}"
       - name: Run Example Script 01
-        run: python ./eplus_api_helpers/demos/01_simple_library_call.py "./${{ matrix.file_base_name }}"
+        run: python ./energyplus_api_helpers/demos/01_simple_library_call.py "./${{ matrix.file_base_name }}"
 #      - name: Run Example Script 02
-#        run: python ./eplus_api_helpers/demos/02_threaded.py "./${{ matrix.file_base_name }}"
+#        run: python ./energyplus_api_helpers/demos/02_threaded.py "./${{ matrix.file_base_name }}"
       - name: Run Example Script 03
-        run: python ./eplus_api_helpers/demos/03_multiprocessed.py "./${{ matrix.file_base_name }}"
+        run: python ./energyplus_api_helpers/demos/03_multiprocessed.py "./${{ matrix.file_base_name }}"
       - name: Run Example Script 04
-        run: python ./eplus_api_helpers/demos/04_dynamic_terminal_output_progress.py "./${{ matrix.file_base_name }}"
+        run: python ./energyplus_api_helpers/demos/04_dynamic_terminal_output_progress.py "./${{ matrix.file_base_name }}"
       - name: Run Example Script 05
-        run: python ./eplus_api_helpers/demos/05_dynamic_terminal_output.py "./${{ matrix.file_base_name }}"
+        run: python ./energyplus_api_helpers/demos/05_dynamic_terminal_output.py "./${{ matrix.file_base_name }}"

README.md

@@ -2,13 +2,13 @@
 
 This project is a small library of helper functionality and, more importantly, demo scripts, for interacting with the EnergyPlus API.
 The EnergyPlus Python API is not on PyPi (as of now), it simply comes with the EnergyPlus installation.
-This library makes that process a bit easier, and also offers a set of demos in the `eplus_api_helpers/demos` folder.
+This library makes that process a bit easier, and also offers a set of demos in the `energyplus_api_helpers/demos` folder.
 
 A super minimal example using the helper class here:
 
 ```python
 from pathlib import Path
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 helper = EPlusAPIHelper(Path('/path/to/EnergyPlus-22-2-0'))
 api = helper.get_api_instance()

eplus_api_helpers/demos/01_simple_library_call.py → energyplus_api_helpers/demos/01_simple_library_call.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 from sys import argv
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 
 eplus_path = '/eplus/installs/EnergyPlus-22-2-0'

eplus_api_helpers/demos/02_threaded.py → energyplus_api_helpers/demos/02_threaded.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 from sys import argv
 from threading import Thread
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 
 eplus_path = '/eplus/installs/EnergyPlus-22-2-0'

eplus_api_helpers/demos/03_multiprocessed.py → energyplus_api_helpers/demos/03_multiprocessed.py

@@ -1,7 +1,7 @@
 from pathlib import Path
 import multiprocessing as mp
 from sys import argv
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 eplus_path = '/eplus/installs/EnergyPlus-22-2-0'
 if len(argv) > 1:

eplus_api_helpers/demos/04_dynamic_terminal_output_progress.py → energyplus_api_helpers/demos/04_dynamic_terminal_output_progress.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 from sys import argv
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 eplus_path = '/eplus/installs/EnergyPlus-22-2-0'
 if len(argv) > 1:

eplus_api_helpers/demos/05_dynamic_terminal_output.py → energyplus_api_helpers/demos/05_dynamic_terminal_output.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from sys import argv
 import sparkline
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 outdoor_db_handle = None
 plot_data = []

eplus_api_helpers/demos/06_plot_e_plus.py → energyplus_api_helpers/demos/06_plot_e_plus.py

@@ -1,6 +1,6 @@
 import matplotlib.pyplot as plt
 from pathlib import Path
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 
 class PlotManager:

eplus_api_helpers/demos/07_server.py → energyplus_api_helpers/demos/07_server.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from threading import Thread
 from time import sleep
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 app = Flask("EnergyPlus API Server Demo")
 e = EPlusAPIHelper(Path('/eplus/installs/EnergyPlus-22-2-0'))

eplus_api_helpers/demos/08_server_advanced.py → energyplus_api_helpers/demos/08_server_advanced.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from threading import Thread
 from time import sleep
-from eplus_api_helpers.import_helper import EPlusAPIHelper
+from energyplus_api_helpers.import_helper import EPlusAPIHelper
 
 
 class RunConfig:

eplus_api_helpers/import_helper.py → energyplus_api_helpers/import_helper.py

@@ -12,7 +12,7 @@ class _EPlusImporter:
     This class should be used as::
 
         from pathlib import Path
-        from eplus_api_helpers import EPlusImporter
+        from energyplus_api_helpers import EPlusImporter
         p = Path('/path/to/energyplus/install')
         with _EplusImporter() as eplus_helper:
             from pyenergyplus.api import EnergyPlusAPI

setup.py

@@ -6,19 +6,19 @@
 
 setup(
     name="energyplus_api_helpers",
-    version="0.2",
-    packages=['eplus_api_helpers', 'eplus_api_helpers.demos'],
+    version="0.3",
+    packages=['energyplus_api_helpers', 'energyplus_api_helpers.demos'],
     description="A set of helper classes, functions and demos, for interacting with the EnergyPlus Python API",
-    package_data={"eplus_api_helpers.demos": ["*.html"]},
+    package_data={"energyplus_api_helpers.demos": ["*.html"]},
     include_package_data=True,
     long_description=readme_contents,
     long_description_content_type='text/markdown',
     author='Edwin Lee',
     author_email='a@a.a',
-    url='https://github.com/Myoldmopar/EnergyPlusAPIDemos',
+    url='https://github.com/Myoldmopar/EnergyPlusAPIHelper',
     license='UnlicensedForNow',
     install_requires=['matplotlib', 'flask', 'pysparklines', 'asciichartpy'],
-    entry_points={
-        'console_scripts': ['energyplus_pet_gui=energyplus_pet.runner:main_gui']
-    }
+    # entry_points={
+    #     'console_scripts': ['energyplus_api_helper=energyplus_api_helpers.runner:main_gui']
+    # }
 )