updated readme, basefiles for new package and added abstract loader f…

…unction

.copier-answers.yml

@@ -9,6 +9,6 @@ org: mooniean
 project_name: CAKED
 project_short_description: A dataloader abstract package
 python_name: caked
-python_version_range: '>=3.8'
+python_version_range: ">=3.8"
 typing: loose
 url: https://github.com/mooniean/CAKED

.github/workflows/ci.yml

@@ -23,15 +23,16 @@ jobs:
           extra_args: --hook-stage manual --all-files
 
   checks:
-    name: Run tests for Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
+    name:
+      Run tests for Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
     runs-on: ${{ matrix.runs-on }}
     needs: [pre-commit]
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.8, 3.12]     
-        runs-on: [ubuntu-latest]  # can be extended to other OSes, e.g. macOS/Windows if needed
-        
+        python-version: [3.8, 3.12]
+        runs-on: [ubuntu-latest] # can be extended to other OSes, e.g. macOS/Windows if needed
+
     steps:
       - uses: actions/checkout@v4
         with:

.pre-commit-config.yaml

@@ -37,7 +37,6 @@ repos:
       - id: ruff
         args: ["--fix", "--show-fixes"]
 
-
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: "v1.5.1"
     hooks:
@@ -47,7 +46,6 @@ repos:
         additional_dependencies:
           - pytest
 
-
   - repo: https://github.com/shellcheck-py/shellcheck-py
     rev: "v0.9.0.5"
     hooks:

CONTRIBUTING.md

@@ -7,16 +7,12 @@ description of best practices for developing scientific packages.
 
 You can set up a development environment by running:
 
-
-
 ```zsh
 python3 -m venv venv          # create a virtualenv called venv
 source ./.venv/bin/activate   # now `python` points to the virtualenv python
 pip install -v -e ".[dev]"    # -v for verbose, -e for editable, [dev] for dev dependencies
 ```
 
-
-
 # Post setup
 
 You should prepare pre-commit, which will help you by checking that commits pass

README.md

@@ -13,15 +13,15 @@ python -m pip install caked
 ```
 
 From source:
+
 ```bash
-git clone https://github.com/mooniean/CAKED
+git clone https://github.com/alan-turing-institute/CAKED
 cd CAKED
 python -m pip install .
 ```
 
 ## Usage
 
-
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.
@@ -30,10 +30,9 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.
 
 Distributed under the terms of the [MIT license](LICENSE).
 
-
 <!-- prettier-ignore-start -->
-[actions-badge]:            https://github.com/mooniean/CAKED/workflows/CI/badge.svg
-[actions-link]:             https://github.com/mooniean/CAKED/actions
+[actions-badge]:            https://github.com/alan-turing-institute/CAKED/workflows/CI/badge.svg
+[actions-link]:             https://github.com/alan-turing-institute/CAKED/actions
 [pypi-link]:                https://pypi.org/project/CAKED/
 [pypi-platforms]:           https://img.shields.io/pypi/pyversions/CAKED
 [pypi-version]:             https://img.shields.io/pypi/v/CAKED

src/caked/__init__.py

@@ -3,6 +3,5 @@
 """
 from __future__ import annotations
 
-
 __all__ = ("__version__",)
 __version__ = "0.1.0"