Metadata-Version: 2.3
Name: energyplus-service
Version: 0.0.1
Summary: A simple flask EnergyPlus service
Project-URL: Documentation, https://github.com/jasondegraw/energyplus-service#readme
Project-URL: Issues, https://github.com/jasondegraw/energyplus-service/issues
Project-URL: Source, https://github.com/jasondegraw/energyplus-service
Author-email: "Jason W. DeGraw" <jason.degraw@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: click
Requires-Dist: flask
Requires-Dist: httpx
Description-Content-Type: text/markdown

# energyplus-service

[![PyPI - Version](https://img.shields.io/pypi/v/energyplus-service.svg)](https://pypi.org/project/energyplus-service)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/energyplus-service.svg)](https://pypi.org/project/energyplus-service)

-----

**Table of Contents**

- [Installation](#installation)
- [Examples](#examples)
- [License](#license)

## Installation

```console
pip install energyplus-service
```

## Examples

Several examples are provided to test things out. These will work either with the `flask` development server or with `waitress` or `gunicorn` (hopefully). Start up the service with

```console
> energyplus-service dev -e path/to/energyplus.exe
```

or

```console
> scripts/setup-run-env.bat
> waitress-serve --host 127.0.0.1 --port 5000 --call energyplus_service:create_app
```

or

```console
gunicorn version goes here
```

Then the `run-X.py` scripts in the `scripts` subdirectory demonstrate several different ways to use the service.

## License

`energyplus-service` is distributed under the terms of the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) license.
