Merge pull request #9 from dougiesquire/housekeeping

Various housekeeping tasks

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+omit =
+    setup.py
+    versioneer.py
+    unseen/_version.py

.gitattributes

@@ -0,0 +1 @@
+unseen/_version.py export-subst

.github/workflows/pre-commit.yml

@@ -0,0 +1,10 @@
+name: pre-commit
+on: [pull_request, push, workflow_dispatch]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/action@v2.0.0

.github/workflows/tests.yml

@@ -0,0 +1,42 @@
+name: tests
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+        python-version: ["3.7", "3.8", "3.9"]
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+
+      - name: Setup conda environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          miniconda-version: "latest"
+          python-version: ${{ matrix.python-version }}
+          environment-file: ci/environment-${{ matrix.python-version }}.yml
+          activate-environment: unseen-test
+          auto-activate-base: false
+
+      - name: Install
+        shell: bash -l {0}
+        run: python -m pip install -e .
+
+      - name: List installed packages
+        shell: bash -l {0}
+        run: conda list
+
+      - name: Run tests
+        shell: bash -l {0}
+        run: python -m pytest unseen
+
+      - name: Upload code coverage
+        uses: codecov/codecov-action@v1
+        with:
+          file: ./coverage.xml

.gitignore

@@ -1,4 +1,140 @@
-.ipynb_checkpoints/
-__pycache__/
 dask-worker-space/
 
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 21.11b1
+    hooks:
+    - id: black
+      language_version: python3
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+    - id: flake8
+      language_version: python3
+      args: # arguments to configure flake8
+        # making isort line length compatible with black
+        - "--max-line-length=120"
+        - "--max-complexity=18"
+        - "--select=B,C,E,F,W,T4,B9"
+
+        # these are errors that will be ignored by flake8
+        # check out their meaning here
+        # https://flake8.pycqa.org/en/latest/user/error-codes.html
+        - "--ignore=E203,E402,F401"

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+## Contributor guide
+
+This package is still is its very early stages of development. The following covers some general guidelines for maintainers and contributors.
+
+#### Preparing Pull Requests
+1. Fork this respository. It's fine to use "unseen" as your fork repository name because it will live under your username.
+
+2. Clone your fork locally, connect your repository to the upstream (main project), and create a branch to work on:
+
+```
+$ git clone git@github.com:YOUR_GITHUB_USERNAME/unseen.git
+$ cd unseen
+$ git remote add upstream git@github.com:AusClimateService/unseen.git
+$ git checkout -b YOUR-BUGFIX-FEATURE-BRANCH-NAME master
+```
+
+3. Install `unseen`'s dependencies into a new conda environment:
+
+```
+$ conda env create -f environment.yml
+$ conda activate unseen
+```
+
+4. Install `unseen` using the editable flag (meaning any changes you make to the package will be reflected directly in your environment):
+
+```
+$ pip install --no-deps -e .
+```
+
+Aside: to have the changes you make to the package register immediately when running IPython (e.g. a Jupyter notebook), run the following magic commands:
+
+```
+%load_ext autoreload
+%autoreload 2 
+```
+
+5. This project uses `black` to format code and `flake8` for linting. We use `pre-commit` to ensure these have been run. Please set up commit hooks by running the following. This will mean that `black` and `flake8` are run whenever you make a commit:
+
+```
+pre-commit install
+```
+
+You can also run `pre-commit` manually at any point to format your code:
+
+```
+pre-commit run --all-files
+ ```
+
+6. Start making and committing your edits, including adding tests to `unseen/tests` to check that your contributions are doing what they're suppose to. To run the test suite:
+
+```
+pytest unseen
+```