restructured into a package (#6)

akhilpandey95 · Oct 19, 2023 · 9ad6127 · 9ad6127
1 parent 66ae6fc
commit 9ad6127
Show file tree

Hide file tree

Showing 19 changed files with 1,542 additions and 315 deletions.
diff --git a/.github/CODEOWNERS.md b/.github/CODEOWNERS.md
@@ -0,0 +1,2 @@
+@akhilpandey95
+@harishsiravuri
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,14 @@
+name: 'Feature request'
+description: Suggest a new feature or enhancement for gnnNAS.
+labels: [enhancement]
+
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: >
+        Describe the feature or enhancement and explain why it should be implemented.
+        Include a code example if applicable.
+    validations:
+      required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,10 @@
+## Pull Request
+
+### Short Summary
+Include a short summary
+
+### Context
+Add a more detailed explanation of changes
+
+### Is this a Breaking Change?
+Is this a breaking change to the public interface?
diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml
@@ -0,0 +1,106 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+
+jobs:
+  Quality:
+    runs-on: ubuntu-latest
+    environment: github-pages
+    permissions:
+      id-token: write
+      contents: write
+      pages: write
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-python@v3
+      with:
+        python-version: 3.10
+
+    - name: Install Python Poetry
+      uses: abatilo/actions-poetry@v2.3.0
+
+    - name: Configure poetry
+      shell: bash
+      run: python -m poetry config virtualenvs.in-project true
+
+    - name: View poetry version
+      run: poetry --version
+
+    - name: Install dependencies
+      run: |
+        python -m poetry install
+
+    - name: Test
+      run: poetry run python3 -m unittest discover
+
+    - name: Install pdoc3
+      run: pip install pdoc3
+
+    - name: Generate documentation
+      run: poetry run pdoc --html gnnnas --force
+
+    - name: Upload documentation to GitHub Pages
+      uses: actions/upload-pages-artifact@v2
+      with:
+        path: ./html/gnnnas
+
+    - name: Deploy documentation to GitHub Pages
+      uses: actions/deploy-pages@v2
+      with:
+        token: ${{ secrets.GH_TOKEN }}
+
+  Release:
+    needs: Quality
+    if: |
+      github.event_name == 'push' && 
+      github.ref == 'refs/heads/main' && 
+      !contains ( github.event.head_commit.message, 'chore(release)' )
+
+    runs-on: ubuntu-latest
+    concurrency: release
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/setup-python@v3
+        with:
+          python-version: 3.10
+
+      - name: Install Python Poetry
+        uses: abatilo/actions-poetry@v2.3.0
+
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Check release status
+        id: release-status
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: |
+          pip install python-semantic-release
+          if semantic-release --strict version
+          then
+            echo "Releasing new version."
+          else
+            echo "Skipping release steps."
+          fi
+
+      - if: steps.release-status.outputs.released == 'true'
+        name: Release to PyPI
+        id: pypi-release
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry build
+          poetry publish
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,160 @@
+# 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/
+.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_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/#use-with-ide
+.pdm.toml
+
+# 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
+.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/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,69 @@
+# Contributing to kgforge
+
+## Welcome
+Hello! We're glad and grateful that you're interested in contributing to `gnnNAS` :tada:! Below you will find the general guidelines for setting up your environment and creating/submitting `pull requests`.
+
+
+## Table of contents
+
+- [Environment setup](#environment-setup)
+- [Contributing changes](#contributing-changes)
+- [Contributing TLDR](#contributing-tldr)
+- [Community guidelines](#community-guidelines)
+- [Reporting bugs](#submitting-issues/bugs)
+- [Suggesting enhancements](#suggesting-enhancements)
+
+
+## Environment Setup
+Steps:
+1. Create a new env. `gnnNAS` currently supports python 3.10
+2. Fork `gnnNAS`
+3. Install all required and development packages in your new env (I use [poetry](https://github.com/python-poetry/poetry) for dependency management).
+
+```bash
+poetry install --all-extras --with dev,dev-lints
+```
+
+## Contributing Changes
+1. Create a new branch for your addition
+   * General naming conventions (we're not picky):
+      * `/username/<featureName>`: for features
+      * `/username/<fixName>`: for general refactoring or bug fixes
+2. Test your changes:
+   * You can run formatting, lints and tests locally via `poetry run python3 -m unittest discover`, respectively.
+3. Submit a Draft Pull Request. Do it early and mark it `WIP` so I know it's not ready for review just yet. You can also add a label to it if you feel like it :smile:.
+4. Move the `pull_request` out of draft state.
+   * Make sure you fill out the `pull_request` template (included with every `pull_request`)
+5. Request review from one of our maintainers (this should happen automatically via `.github/CODEOWNERS`). 
+6. Get Approval. We'll let you know if there are any changes that are needed. 
+7. Merge your changes into `gnnNAS`!
+
+## Contributing TLDR
+1. Create branch
+2. Add changes
+3. Test locally
+4. Create PR
+5. Get your awesome work reviewed and approved by a maintainer
+6. Merge
+7. Celebrate!
+
+## Community Guidelines
+  1. Be Kind
+    - Working together should be a fun learning opportunity, and we want it to be a good experience for everyone. Please treat each other with respect.  
+    - If something looks outdated or incorrect, please let me know! I want to make `gnnNAS` as useful as possible. 
+  2. Own Your Work
+     * Creating a PR for `gnnNAS` is your first step to becoming a contributor, so make sure that you own your changes. 
+     * Our maintainers will do their best to respond to you in a timely manner, but we ask the same from you as the contributor. 
+
+## Submitting issues/bugs
+
+We use [GitHub issues](https://github.com/akhilpandey95/gnnNAS/issues) to track bugs and suggested enhancements. You can report a bug by opening a new issue [new issue](https://github.com/akhilpandey95/gnnNAS/issues/new/choose) Before reporting a bug/issue, please check that it has not already been reported, and that it is not already fixed in the latest version. If you find a closed issue related to your current issue, please open a new issue and include a link to the original issue in the body of your new one. Please include as much information about your bug as possible.
+
+## Suggesting enhancements
+
+You can suggest an enhancement by opening a [new feature request](https://github.com/akhilpandey95/gnnNAS/issues/new?labels=enhancement&template=feature_request.yml).
+Before creating an enhancement suggestion, please check that a similar issue does not already exist.
+
+Please describe the behavior you want and why, and provide examples of how `gnnNAS` would be used if your feature were added.
+
+## _Thank you!_