https://github.com/pollination/pollination-apps
A python library to setup and deploy Apps to Pollination!
https://github.com/pollination/pollination-apps
Last synced: 11 months ago
JSON representation
A python library to setup and deploy Apps to Pollination!
- Host: GitHub
- URL: https://github.com/pollination/pollination-apps
- Owner: pollination
- License: mit
- Created: 2022-03-06T21:39:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T07:17:51.000Z (over 1 year ago)
- Last Synced: 2024-11-21T17:56:33.907Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 975 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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