feat(init): Initial commit of everything to start the package

.github/workflows/ci.yaml

@@ -0,0 +1,91 @@
+---
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+
+  test:
+    name: Unit tests
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.12']
+        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 standards-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/main' && github.repository_owner == 'ladybug-tools'
+    steps:
+      - uses: actions/checkout@v2
+      - name: set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.12'
+      - name: set up node  # we need node for for semantic release
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.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@^23.1.1 --dryRun | grep -oP 'Published release \K.*? ' || true`"
+          npx semantic-release@^23.1.1
+          echo "::set-output name=tag::$nextRelease"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+          PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
+
+  docs:
+    name: Generate docs
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.ref == 'refs/heads/main' && github.repository_owner == 'ladybug-tools'
+    steps:
+      - uses: actions/checkout@v2
+      - name: set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.12'
+      - name: install dependencies
+        run: |
+          pip install -U .
+          pip install -r dev-requirements.txt
+          sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_openstudio
+          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'

.gitignore

@@ -1,162 +1,19 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
+*.pyc
+test.py
+*.gh
+.pytest_cache
+/__pycache__
 .coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
+*.ipynb
 .ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
-.pdm.toml
-.pdm-python
-.pdm-build/
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
+.tox
+*.egg-info
+tox.ini
+/.cache
+/.vscode
+honeybee.log*
 .env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+htmlcov/*
+.DS_store
+/build
+.eggs

.releaserc.json

@@ -0,0 +1,20 @@
+{
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        [
+            "@semantic-release/github",
+            {
+                "successComment": false,
+                "failTitle": false
+            }
+        ],
+        [
+            "@semantic-release/exec",
+            {
+                "publishCmd": "bash deploy.sh"
+            }
+        ]
+    ],
+    "branches": ["main"]
+}

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).

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).

MANIFEST.in

@@ -0,0 +1,6 @@
+recursive-exclude tests *
+recursive-exclude docs *
+recursive-exclude .github *
+exclude .gitignore
+exclude .releaserc.json
+exclude deploy.sh

README.md

@@ -1,2 +1,45 @@
 # honeybee-openstudio
-:honeybee: :gem: Python package for translating between Honeybee and OpenStudio
+
+Honeybee extension for translation to/from OpenStudio.
+
+Specifically, this package extends [honeybee-core](https://github.com/ladybug-tools/honeybee-core) and [honeybee-energy](https://github.com/ladybug-tools/honeybee-energy) to perform translations to/from OpenStudio using the [OpenStudio](https://github.com/NREL/OpenStudio) SDK.
+
+## Installation
+
+`pip install -U honeybe-openstudio`
+
+## QuickStart
+
+```console
+import honeybee_openstudio
+```
+
+## [API Documentation](http://ladybug-tools.github.io/honeybee-openstudio/docs)
+
+## Local Development
+
+1. Clone this repo locally
+```console
+git clone git@github.com:ladybug-tools/honeybee-openstudio
+
+# or
+
+git clone https://github.com/ladybug-tools/honeybee-openstudio
+```
+2. Install dependencies:
+```
+cd honeybee-openstudio
+pip install -r dev-requirements.txt
+pip install -r requirements.txt
+```
+
+3. Run Tests:
+```console
+python -m pytest tests/
+```
+
+4. Generate Documentation:
+```console
+sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_openstudio
+sphinx-build -b html ./docs ./docs/_build/docs
+```

deploy.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+echo "Building distribution"
+python setup.py sdist bdist_wheel
+echo "Pushing new version to PyPi"
+twine upload dist/* -u $PYPI_USERNAME -p $PYPI_PASSWORD

dev-requirements.txt

@@ -0,0 +1,10 @@
+pytest==8.3.2
+Sphinx==8.0.2
+sphinx-bootstrap-theme==0.8.1
+sphinxcontrib-fulltoc==1.2.0
+sphinxcontrib-websupport==2.0.0
+sphinx-click==6.0.0
+twine==5.1.1
+wheel==0.44.0
+setuptools==75.1.0
+importlib-metadata==8.5.0

docs/README.md

@@ -0,0 +1,15 @@
+
+## Usage
+For generating the documents locally use commands below from the root folder. 
+
+```shell
+# install dependencies
+cd honeybee_openstudio
+pip install -r requirements.txt
+pip install -r dev-requirements.txt
+
+# generate rst files for modules
+sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_openstudio
+# build the documentation under _build/docs folder
+sphinx-build -b html ./docs ./docs/_build/docs
+```