dragonfly-display 0.1.0__tar.gz

dragonfly-display-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,107 @@
+---
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+
+  test:
+    name: Unit tests
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.10']
+        os: [macos-latest, ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: install python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r extras-requirements.txt
+          pip install -r dev-requirements.txt
+      - name: run tests
+        run: python -m pytest tests/
+
+  deploy:
+    name: Deploy to GitHub and PyPI
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.ref == 'refs/heads/master' && github.repository_owner == 'ladybug-tools'
+    steps:
+      - uses: actions/checkout@v2
+      - name: set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: set up node  # we need node for for semantic release
+        uses: actions/setup-node@v2.1.2
+        with:
+          node-version: 14.2.0
+      - name: install python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r dev-requirements.txt
+      - name: install semantic-release
+        run:
+          npm install @semantic-release/exec
+      - name: run semantic release
+        id: new_release
+        run: |
+          nextRelease="`npx semantic-release@^17.0.0 --dryRun | grep -oP 'Published release \K.*? ' || true`"
+          npx semantic-release@^17.0.0
+          echo "::set-output name=tag::$nextRelease"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+          PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      - name: sleep for 5 minutes for PyPI update
+        if: contains(steps.new_release.outputs.tag, '.')
+        run: sleep 300s
+        shell: bash
+      - name: Update lbt-dragonfly
+        if: contains(steps.new_release.outputs.tag, '.')
+        env:
+          DISPATCH_REPO: ladybug-tools/lbt-dragonfly
+          DEPS_TOKEN: ${{ secrets.DEPS_UPDATING }}
+        run: |
+          curl -X POST https://api.github.com/repos/$DISPATCH_REPO/dispatches \
+          -H "Accept: application/vnd.github.everest-preview+json" \
+          -d '{"event_type": "dragonfly_display_release", "client_payload": {"version": "${{ steps.new_release.outputs.tag }}"}}' \
+          -u ladybugbot:$DEPS_TOKEN
+
+  docs:
+    name: Generate docs
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.ref == 'refs/heads/master' && github.repository_owner == 'ladybug-tools'
+    steps:
+      - uses: actions/checkout@v2
+      - name: set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: install dependencies
+        run: |
+          pip install -U .
+          pip install -r dev-requirements.txt
+          sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_display
+          sphinx-build -b html ./docs ./docs/_build/docs
+      - name: deploy to github pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          # this will use ladybugbot token
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: docs/_build/
+          force_orphan: true
+          keep_files: false
+          full_commit_message: 'deploy: update docs'

dragonfly-display-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+*.pyc
+test.py
+.pytest_cache
+*__pycache__
+.coverage
+*.ipynb
+.ipynb_checkpoints
+.tox
+*.egg-info
+tox.ini
+/.cache
+/.vscode
+.eggs
+*.code-workspace
+/build

dragonfly-display-0.1.0/.releaserc.json

@@ -0,0 +1,13 @@
+{
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/github",
+        [
+            "@semantic-release/exec",
+            {
+                "publishCmd": "bash deploy.sh ${nextRelease.version}"
+            }
+        ]
+    ]
+}

dragonfly-display-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+Contributor Covenant Code of Conduct
+=========================================
+
+This project follows Ladybug Tools contributor covenant code of conduct. See our [contributor covenant code of conduct](https://github.com/ladybug-tools/contributing/blob/master/CODE-OF-CONDUCT.md).

dragonfly-display-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+Contributing
+------------
+We welcome contributions from anyone, even if you are new to open source we will be happy to help you to get started. Most of the Ladybug Tools developers started learning programming through developing for Ladybug Tools.
+
+### Code contribution
+This project follows Ladybug Tools contributing guideline. See [contributing to Ladybug Tools projects](https://github.com/ladybug-tools/contributing/blob/master/README.md).

dragonfly-display-0.1.0/Dockerfile

@@ -0,0 +1,42 @@
+FROM python:3.10-slim
+
+LABEL maintainer="Ladybug Tools" email="info@ladybug.tools"
+
+ENV HOMEDIR='/home/ladybugbot'
+ENV PATH="${HOMEDIR}/.local/bin:${PATH}"
+ENV LIBRARYDIR="${HOMEDIR}/lib"
+ENV RUNDIR="${HOMEDIR}/run"
+
+RUN apt-get update \
+    && apt-get -y install ffmpeg libsm6 libxext6 xvfb --no-install-recommends git \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create non-root user
+RUN adduser ladybugbot --uid 1000 --disabled-password --gecos ""
+USER ladybugbot
+WORKDIR ${HOMEDIR}
+RUN mkdir ladybug_tools && touch ladybug_tools/config.json
+
+# Install dragonfly-display
+COPY dragonfly_display ${LIBRARYDIR}/dragonfly_display
+COPY .git ${LIBRARYDIR}/.git
+COPY setup.py ${LIBRARYDIR}
+COPY setup.cfg ${LIBRARYDIR}
+COPY requirements.txt ${LIBRARYDIR}
+COPY extras-requirements.txt ${LIBRARYDIR}
+COPY README.md ${LIBRARYDIR}
+COPY LICENSE ${LIBRARYDIR}
+
+USER root
+RUN pip3 install --no-cache-dir setuptools wheel xvfbwrapper \
+    && pip3 install --no-cache-dir ${LIBRARYDIR}[full] \
+    && apt-get -y --purge remove git \
+    && apt-get -y clean \
+    && apt-get -y autoremove \
+    && rm -rf ${LIBRARYDIR}/.git
+
+USER ladybugbot
+# Set up working directory
+RUN mkdir -p ${RUNDIR}/simulation
+WORKDIR ${RUNDIR}