Prerelease 1.0.0

.coveragerc

@@ -0,0 +1,18 @@
+[run]
+source = cosmotech.coal
+omit =
+    */tests/*
+    */site-packages/*
+    */__pycache__/*
+
+[report]
+exclude_lines =
+    pragma: no cover
+    def __repr__
+precision = 2
+skip_covered = true
+
+[html]
+directory = coverage_html_report
+skip_covered = false
+skip_empty = true

.github/workflows/check_untested_functions.yml

@@ -0,0 +1,31 @@
+name: Check Untested Functions
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  check-untested-functions:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[test]"
+
+    - name: Run untested functions check
+      run: |
+        python find_untested_functions.py
+        # This is informational only for now, will not fail the build
+        # In the future, we can make this fail the build by adding:
+        # exit $(python find_untested_functions.py | grep "Total untested functions:" | awk '{print $4}')

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Lint
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.dev.txt
+    - name: Check code formatting with Black
+      run: |
+        black --check .

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[test]"
+
+    - name: Run tests with coverage
+      run: |
+        pytest tests/unit/coal/ --cov=cosmotech.coal --cov-report=term

.gitignore

@@ -131,4 +131,8 @@ dmypy.json
 tmp/
 .idea/
 
-generated/
+generated/
+.vscode/
+
+# sonarcube folders
+.scannerwork/

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-added-large-files
+
+-   repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+    -   id: black
+
+-   repo: local
+    hooks:
+    -   id: pytest-check
+        name: pytest-check
+        entry: pytest tests/unit/coal/ --cov=cosmotech.coal --cov-report=term-missing --cov-fail-under=90
+        language: system
+        pass_filenames: false
+        always_run: true
+    -   id: check-untested-functions
+        name: check-untested-functions
+        entry: python find_untested_functions.py
+        language: system
+        pass_filenames: false
+        always_run: true

BLACK_SETUP.md

@@ -0,0 +1,111 @@
+# Black Code Formatter Setup
+
+This project uses [Black](https://github.com/psf/black) for code formatting to ensure consistent code style across the codebase.
+
+## Configuration
+
+Black is configured in the `pyproject.toml` file with the following settings:
+
+```toml
+[tool.black]
+line-length = 120
+target-version = ["py311"]
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  | generated
+  | __pycache__
+)/
+'''
+```
+
+## Installation
+
+Install Black and other development tools:
+
+```bash
+pip install -r requirements.dev.txt
+```
+
+Or install Black directly:
+
+```bash
+pip install black==23.3.0
+```
+
+## Usage
+
+### Manual Usage
+
+Run Black on your codebase:
+
+```bash
+# Format all Python files in the project
+python -m black .
+
+# Format a specific directory
+python -m black cosmotech/coal/
+
+# Check if files would be reformatted without actually changing them
+python -m black --check .
+
+# Show diff of changes without writing files
+python -m black --diff .
+```
+
+### Pre-commit Hooks
+
+This project uses pre-commit hooks to automatically run Black before each commit. To set up pre-commit:
+
+1. Install pre-commit:
+
+```bash
+pip install pre-commit
+```
+
+2. Install the git hooks:
+
+```bash
+pre-commit install
+```
+
+Now Black will run automatically on the files you've changed when you commit.
+
+### VSCode Integration
+
+If you use VSCode, the included settings in `.vscode/settings.json` will automatically format your code with Black when you save a file. Make sure you have the Python extension installed.
+
+## CI Integration
+
+To enforce Black formatting in your CI pipeline, add a step to run Black in check mode:
+
+```yaml
+- name: Check code formatting with Black
+  run: |
+    python -m pip install black==23.3.0
+    python -m black --check .
+```
+
+## Migrating Existing Code
+
+When first applying Black to an existing codebase, you might want to:
+
+1. Run Black with `--diff` first to see the changes
+2. Consider running it on one module at a time
+3. Make the formatting change in a separate commit from functional changes
+
+## Benefits of Using Black
+
+- Eliminates debates about formatting
+- Consistent code style across the entire codebase
+- Minimal configuration needed
+- Widely adopted in the Python community