Release the initial version. (#1)

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,29 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+### Bug description
+
+A clear and concise description of what the bug is.
+
+### To Reproduce
+
+Ideally, provide a minimal code example. If that's not possible, describe steps to reproduce the bug.
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Screenshots/Error messages
+
+If applicable, add screenshots to help explain your problem.
+
+### System
+
+ - OS: [e.g. Ubuntu 18.04]
+ - Version [e.g. 0.0.1]

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,25 @@
+---
+name: Enhancement
+about: Enhance an existing component.
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+* pybaum version used, if any:
+* Python version, if any:
+* Operating System:
+
+### What would you like to enhance and why? Is it related to an issue/problem?
+
+A clear and concise description of the current implementation and its limitations.
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've
+considered and why you have discarded them.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature-request
+assignees: ''
+
+---
+
+### Current situation
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]; Currently there is no way of [...]
+
+### Desired Situation
+
+What functionality should become possible or easier?
+
+### Proposed implementation
+
+How would you implement the new feature? Did you consider alternative implementations?
+You can start by describing interface changes like a new argument or a new function. There is no need to get too detailed here.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,11 @@
+### What problem do you want to solve?
+
+Reference the issue or discussion, if there is any. Provide a description of your
+proposed solution.
+
+### Todo
+
+- [ ] Target the right branch and pick an appropriate title.
+- [ ] Put `Closes #XXXX` in the first PR comment to auto-close the relevant issue once
+  the PR is accepted. This is not applicable if there is no corresponding issue.
+- [ ] Any steps that still need to be done.

.github/workflows/continuous-integration-workflow.yml

@@ -0,0 +1,93 @@
+name: Continuous Integration Workflow
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - '*'
+
+# Automatically cancel a previous run.
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+
+  run-tests:
+
+    name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+        python-version: ['3.7', '3.8', 3.9]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install core dependencies.
+        shell: bash -l {0}
+        run: conda install -c conda-forge tox-conda
+
+      - name: Install fixes for Python 3.7 on Windows
+        if: runner.os == 'Windows' && matrix.python-version == '3.7'
+        shell: bash -l {0}
+        run: conda install -c conda-forge bokeh conda-build numpy scipy joblib
+
+      - name: Run pytest.
+        shell: bash -l {0}
+        run: tox -e pytest -- -m "not slow" --cov-report=xml --cov=./
+
+      - name: Upload coverage report.
+        if: runner.os == 'Linux' && matrix.python-version == '3.8'
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+
+  pre-commit:
+
+    name: Run pre-commit.
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: pip install tox
+
+      - name: Run pre-commit
+        run: tox -e pre-commit
+
+
+  docs:
+
+    name: Run documentation.
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          python-version: 3.8
+
+      - name: Install core dependencies.
+        shell: bash -l {0}
+        run: conda install -c conda-forge tox-conda
+
+      - name: Build docs
+        shell: bash -l {0}
+        run: tox -e sphinx

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,34 @@
+name: PyPI
+
+on: push
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+
+src/pybaum/_version.py

.pre-commit-config.yaml

@@ -0,0 +1,108 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+    -   id: check-merge-conflict
+    -   id: debug-statements
+    -   id: end-of-file-fixer
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: v2.6.0
+    hooks:
+    -   id: reorder-python-imports
+        types: [python]
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+    -   id: check-added-large-files
+        args: ['--maxkb=100']
+    -   id: check-case-conflict
+    -   id: check-merge-conflict
+    -   id: check-vcs-permalinks
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: end-of-file-fixer
+    -   id: fix-byte-order-marker
+    -   id: mixed-line-ending
+    -   id: no-commit-to-branch
+        args: [--branch, main]
+    -   id: trailing-whitespace
+-   repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0
+    hooks:
+    -   id: python-check-blanket-noqa
+    -   id: python-check-mock-methods
+    -   id: python-no-eval
+    -   id: python-no-log-warn
+    -   id: python-use-type-annotations
+    -   id: rst-backticks
+    -   id: rst-directive-colons
+    -   id: rst-inline-touching-normal
+    -   id: text-unicode-replacement-char
+-   repo: https://github.com/asottile/blacken-docs
+    rev: v1.12.0
+    hooks:
+    -   id: blacken-docs
+        additional_dependencies: [black]
+        types: [rst]
+-   repo: https://github.com/psf/black
+    rev: 21.12b0
+    hooks:
+    -   id: black
+        types: [python]
+-   repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+    -   id: flake8
+        types: [python]
+        additional_dependencies: [
+            flake8-alfred,
+            flake8-bugbear,
+            flake8-builtins,
+            flake8-comprehensions,
+            flake8-docstrings,
+            flake8-eradicate,
+            flake8-print,
+            flake8-pytest-style,
+            flake8-todo,
+            flake8-typing-imports,
+            flake8-unused-arguments,
+            pep8-naming,
+            pydocstyle,
+            Pygments,
+        ]
+-   repo: https://github.com/PyCQA/doc8
+    rev: 0.10.1
+    hooks:
+        -   id: doc8
+-   repo: meta
+    hooks:
+    -   id: check-hooks-apply
+    -   id: check-useless-excludes
+    # -   id: identity  # Prints all files passed to pre-commits. Debugging.
+-   repo: https://github.com/mgedmin/check-manifest
+    rev: "0.47"
+    hooks:
+    -   id: check-manifest
+-   repo: https://github.com/PyCQA/doc8
+    rev: 0.10.1
+    hooks:
+    -   id: doc8
+-   repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v1.20.0
+    hooks:
+    -   id: setup-cfg-fmt
+-   repo: https://github.com/econchick/interrogate
+    rev: 1.5.0
+    hooks:
+    -   id: interrogate
+        args: [-v, --fail-under=20]
+        exclude: ^(docs|setup\.py)
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.1.0
+  hooks:
+    -   id: codespell
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.0
+    hooks:
+    -   id: pyupgrade
+        args: [--py37-plus]

.readthedocs.yml

@@ -0,0 +1,10 @@
+version: 2
+
+build:
+  image: latest
+
+python:
+  version: 3.9
+
+conda:
+  environment: docs/environment.yml

CHANGES.rst

@@ -0,0 +1,7 @@
+Changes
+^^^^^^^
+
+This is a record of all past pybaum releases and what went into them in reverse
+chronological order. We follow `semantic versioning <https://semver.org/>`_ and all
+releases are available on `Anaconda.org
+<https://anaconda.org/OpenSourceEconomics/pybaum>`_.

LICENSE

@@ -2,20 +2,19 @@ MIT License
 
 Copyright (c) 2022 Open Source Economics
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the following
+conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
+OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,10 @@
+include CITATION
+include LICENSE
+include CHANGES.rst
+
+exclude *.yaml
+exclude *.yml
+exclude tox.ini
+
+prune docs
+prune tests