Metadata-Version: 2.1
Name: pollination-apps
Version: 0.1.0
Summary: A library to setup and deploy Apps to Pollination!
Home-page: https://github.com/pollination/pollination-apps
Author: Ladybug Tools
Author-email: info@ladybug.tools
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: pollination-sdk (>=0.27.0)
Requires-Dist: pydantic (==1.8.2)
Requires-Dist: PyYAML (==5.4.1)
Requires-Dist: jsonschema (==3.2.0)
Requires-Dist: click (>=7.0)
Requires-Dist: python-slugify (==4.0.0)
Requires-Dist: cookiecutter (==1.7.3)

# Pollination Apps

A python library to setup and deploy Apps to Pollination!

## Installation

```
> pip install pollination-apps
```

## Documentation

You can access the full docs for this package and its CLI
[here](https://pollination.github.io/pollination-apps/).

## Local Development

1. Clone this repo locally

   ```console
   git clone git@github.com:ladybug-tools/pollination-apps
   ```

   or

   ```console
   git clone https://github.com/ladybug-tools/pollination-apps
   ```

2. Install dependencies:

   ```console
   cd pollination-apps
   pip install -r dev-requirements.txt
   pip install -r requirements.txt
   ```

3. Run Tests:

   ```console
   python -m pytest tests/
   ```

4. Generate Documentation:

   ```python
   sphinx-apidoc -f -e -d 4 -o ./docs/modules ./pollination-apps
   sphinx-build -b html ./docs ./docs/_build
   ```

5. Preview Documentation:

   ```console
   python -m http.server --directory ./docs/_build/
   ```

   Now you can see the documentation preview at http://localhost:8000


