Merging development to main branch

.github/workflows/build.yml

@@ -0,0 +1,52 @@
+# This is a basic workflow to help you get started with Actions
+
+# Name of the workflow
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for 
+  # the main branch
+  push:
+    branches: [ main , dev ]
+  pull_request:
+    branches: [ main , dev]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run 
+# sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+
+    # Steps represent a sequence of tasks that will be executed as 
+    # part of the job
+    steps:
+      # Checks-out your repository so your job can access it
+      - name: Check-out repository
+        uses: actions/checkout@v2
+
+      # Set up Python
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[tests]
+
+      # Run pytest with coverage
+      - name: Run tests with coverage
+        run: |
+          pytest --cov --cov-report=term --cov-branch

.github/workflows/deploy.yaml

@@ -0,0 +1,112 @@
+# Workflow for publishing into pyPI
+
+name: ci-cd
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  ci:
+    # Set up operating system
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+
+    # Steps represent a sequence of tasks that will be executed as 
+    # part of the job
+    steps:
+      # Checks-out your repository so your job can access it
+      - name: Check-out repository
+        uses: actions/checkout@v2
+
+      # Set up Python
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[tests]
+
+      # Run pytest with coverage
+      - name: Run tests with coverage
+        run: |
+          pytest --cov --cov-report=term --cov-branch
+
+  cd:
+
+    # Set up operating system
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+      contents: write
+    # Only run this job if the "ci" job passes
+    needs: ci
+
+    # Only run this job if new work is pushed to "main" or "dev"
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main')
+
+    # Define job steps
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[dev]
+
+      - name: Hatch build locally
+        run: hatch build
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+  testdumbpy:
+
+    # Set up operating system
+    runs-on: ubuntu-latest
+
+    needs: cd
+
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+
+    steps:
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Test install from TestPyPI
+        run: |
+          python -m pip install --upgrade pip
+          pip install \
+          --index-url https://test.pypi.org/simple/ \
+          --extra-index-url https://pypi.org/simple/ \
+          dumbpy
+
+
+

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install package + quartodoc + jupyter
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install quartodoc jupyter nbformat
+
+      - name: Generate reference pages
+        run: quartodoc build --config docs/_quarto.yml
+
+      - uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Render Quarto site
+        run: quarto render docs
+
+      - uses: actions/configure-pages@v5
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site
+
+  deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,12 +1,5 @@
 # Welcome to dumbpy
 
-|  |  |
-|------------------------------------|------------------------------------|
-| Package | [![Latest PyPI Version](https://img.shields.io/pypi/v/dumbpy.svg)](https://pypi.org/project/dumbpy/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/dumbpy.svg)](https://pypi.org/project/dumbpy/) |
-| Meta | [![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) |
-
-*TODO: the above badges that indicate python version and package version will only work if your package is on PyPI. If you don't plan to publish to PyPI, you can remove them.*
-
 DumbPy is an alternative version of NumPy, which facilitates scientific computing using Python. DumbPy contains numeric functions that provide useful summary statistics of numerical lists, listed below. DumbPy additionally carries out strict input testing to provide clear and user-friendly error messages and facilitate proper usage.
 
 DumbPy Functions:
@@ -21,18 +14,12 @@ DumbPy Functions:
 
 As stated above, the NumPy package already exists and provides similar functions. NumPy can be found at the following link: <https://numpy.org/>. DumbPy is an alternative version, which is much simpler and has a narrower focus.
 
-## Contributors
-
--   Hector Prieto
--   Nicole Link
--   Samrawit Mezgebo
-
 ## Get started
 
 You can install this package into your preferred Python environment using pip:
 
 ``` bash
-$ pip install dumbpy
+pip install dumbpy 
 ```
 
 To use dumbpy in your code:
@@ -43,7 +30,63 @@ To use dumbpy in your code:
 2.0
 ```
 
+## Contributors
+
+-   Hector Palafox
+-   Nicole Link
+-   Samrawit Mezgebo
+
+
+## Development 
+
+**1) Clone the repository**
+```bash
+git clone https://github.com/UBC-MDS/dumbpy.git
+cd dumbpy
+```
+
+**2) Create the conda environment**
+
+```bash
+conda env create -f environment.yml
+```
+
+**3) Activate the environment**
+
+```bash
+conda activate dumbpy-env
+```
+
+**4) Install the package locally**
+
+```bash
+python -m pip install -e .
+```
+
+**5) Run the test suite**
+
+```bash
+pytest
+```
+
+**6) Build the documentation**
+
+```bash
+cd docs
+quarto render
+```
+
+**7) Preview the documentation locally(optional)**
+
+```bash
+quarto preview
+```
+
+Docs are deployed automatically via GitHub Actions on merges to the deployment branch.
+
+Deployed docs: <add github pages url here>
+
 ## Copyright
 
--   Copyright © 2026 Hector Palafox.
+-   Copyright © 2026 Hector Palafox, Nicole Link, Samrawit Mezgebo.
 -   Free software distributed under the [MIT License](./LICENSE).

docs/.gitignore

@@ -0,0 +1,6 @@
+/.quarto/
+**/*.quarto_ipynb
+
+# Quarto build output
+_site/
+.quarto/

docs/_quarto.yml

@@ -0,0 +1,43 @@
+project:
+  type: website
+
+execute:
+  enabled: false
+
+jupyter: python3
+
+# tell quarto to read the generated sidebar + styles from quartodoc
+metadata-files:
+  - reference/_sidebar.yml
+
+format:
+  html:
+    theme: cosmo
+    toc: true
+    css:
+      - reference/_styles-quartodoc.css
+
+website:
+  title: "dumbpy"
+  navbar:
+    left:
+      - href: index.qmd
+        text: Home
+      - href: examples.qmd
+        text: Examples
+      - href: reference/index.qmd
+        text: Reference
+
+quartodoc:
+  package: dumbpy
+  sidebar: reference/_sidebar.yml
+  css: reference/_styles-quartodoc.css
+  sections:
+    - title: Public API
+      desc: Core functions exported by `dumbpy`.
+      contents:
+        - arithmetic_mean
+        - std_deviation
+        - median
+        - flatten_list
+        - validate_list