initial commits

FleischerResearchLab · Apr 10, 2023 · 0c74976 · 0c74976
1 parent e651176
commit 0c74976
Show file tree

Hide file tree

Showing 23 changed files with 646 additions and 1 deletion.
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -0,0 +1,14 @@
+name: Deploy to GitHub Pages
+
+permissions:
+  contents: write
+  pages: write
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  workflow_dispatch:
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps: [uses: fastai/workflows/quarto-ghp@master]
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -0,0 +1,7 @@
+name: CI
+on:  [workflow_dispatch, pull_request, push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps: [uses: fastai/workflows/nbdev-ci@master]
diff --git a/CanvasGroupy/__init__.py b/CanvasGroupy/__init__.py
@@ -0,0 +1 @@
+__version__ = "0.0.1"
diff --git a/CanvasGroupy/_modidx.py b/CanvasGroupy/_modidx.py
@@ -0,0 +1,8 @@
+# Autogenerated by nbdev
+
+d = { 'settings': { 'branch': 'main',
+                'doc_baseurl': '/CanvasGroupy',
+                'doc_host': 'https://FleischerResearchLab.github.io',
+                'git_url': 'https://github.com/FleischerResearchLab/CanvasGroupy',
+                'lib_path': 'CanvasGroupy'},
+  'syms': {'CanvasGroupy.core': {'CanvasGroupy.core.foo': ('core.html#foo', 'CanvasGroupy/core.py')}}}
diff --git a/CanvasGroupy/core.py b/CanvasGroupy/core.py
@@ -0,0 +1,7 @@
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_core.ipynb.
+
+# %% auto 0
+__all__ = ['foo']
+
+# %% ../nbs/00_core.ipynb 3
+def foo(): pass
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__
diff --git a/README.md b/README.md
@@ -1,2 +1,22 @@
 # CanvasGroupy
-Canvas Grouping Python Script
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+This file will become your README and also the index of your
+documentation.
+
+## Install
+
+``` sh
+pip install CanvasGroupy
+```
+
+## How to use
+
+Fill me in please! Don’t forget code examples:
+
+``` python
+1+1
+```
+
+    2
diff --git a/_proc/.gitignore b/_proc/.gitignore
@@ -0,0 +1 @@
+/.quarto/
diff --git a/_proc/00_core.ipynb b/_proc/00_core.ipynb
@@ -0,0 +1,73 @@
+{
+ "cells": [
+  {
+   "cell_type": "raw",
+   "metadata": {},
+   "source": [
+    "---\n",
+    "description: Fill in a module description here\n",
+    "output-file: core.html\n",
+    "title: core\n",
+    "\n",
+    "---\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/markdown": [
+       "---\n",
+       "\n",
+       "### foo\n",
+       "\n",
+       ">      foo ()"
+      ],
+      "text/plain": [
+       "---\n",
+       "\n",
+       "### foo\n",
+       "\n",
+       ">      foo ()"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "#| echo: false\n",
+    "#| output: asis\n",
+    "show_doc(foo)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "widgets": {
+   "application/vnd.jupyter.widget-state+json": {
+    "state": {},
+    "version_major": 2,
+    "version_minor": 0
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}
diff --git a/_proc/_docs/index.html b/_proc/_docs/index.html
@@ -0,0 +1,8 @@
+<html xmlns="http://www.w3.org/1999/xhtml">    
+  <head>      
+    <title>Redirect to core.html</title>      
+    <meta http-equiv="refresh" content="0;URL='core.html'" />    
+  </head>    
+  <body> 
+  </body>  
+</html>     
diff --git a/_proc/_docs/robots.txt b/_proc/_docs/robots.txt
@@ -0,0 +1 @@
+Sitemap: https://FleischerResearchLab.github.io/CanvasGroupy/sitemap.xml
diff --git a/_proc/_docs/sitemap.xml b/_proc/_docs/sitemap.xml
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+</urlset>
diff --git a/_proc/_quarto.yml b/_proc/_quarto.yml
@@ -0,0 +1,20 @@
+project:
+  type: website
+
+format:
+  html:
+    theme: cosmo
+    css: styles.css
+    toc: true
+
+website:
+  twitter-card: true
+  open-graph: true
+  repo-actions: [issue]
+  navbar:
+    background: primary
+    search: true
+  sidebar:
+    style: floating
+
+metadata-files: [nbdev.yml, sidebar.yml]
diff --git a/_proc/index.ipynb b/_proc/index.ipynb
@@ -0,0 +1,108 @@
+{
+ "cells": [
+  {
+   "cell_type": "raw",
+   "metadata": {},
+   "source": [
+    "---\n",
+    "description: Canvas Grouping Python Script\n",
+    "output-file: index.html\n",
+    "title: CanvasGroupy\n",
+    "\n",
+    "---\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This file will become your README and also the index of your documentation."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Install"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "```sh\n",
+    "pip install CanvasGroupy\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## How to use"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Fill me in please! Don't forget code examples:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "language": "python"
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "2"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "1+1"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "language": "python"
+   },
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "widgets": {
+   "application/vnd.jupyter.widget-state+json": {
+    "state": {},
+    "version_major": 2,
+    "version_minor": 0
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}
diff --git a/_proc/nbdev.yml b/_proc/nbdev.yml
@@ -0,0 +1,9 @@
+project:
+  output-dir: _docs
+
+website:
+  title: "CanvasGroupy"
+  site-url: "https://FleischerResearchLab.github.io/CanvasGroupy"
+  description: "Canvas Grouping Python Script"
+  repo-branch: main
+  repo-url: "https://github.com/FleischerResearchLab/CanvasGroupy"
diff --git a/_proc/styles.css b/_proc/styles.css
@@ -0,0 +1,37 @@
+.cell {
+  margin-bottom: 1rem;
+}
+
+.cell > .sourceCode {
+  margin-bottom: 0;
+}
+
+.cell-output > pre {
+  margin-bottom: 0;
+}
+
+.cell-output > pre, .cell-output > .sourceCode > pre, .cell-output-stdout > pre {
+  margin-left: 0.8rem;
+  margin-top: 0;
+  background: none;
+  border-left: 2px solid lightsalmon;
+  border-top-left-radius: 0;
+  border-top-right-radius: 0;
+}
+
+.cell-output > .sourceCode {
+  border: none;
+}
+
+.cell-output > .sourceCode {
+  background: none;
+  margin-top: 0;
+}
+
+div.description {
+  padding-left: 2px;
+  padding-top: 5px;
+  font-style: italic;
+  font-size: 135%;
+  opacity: 70%;
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Sitemap: https://FleischerResearchLab.github.io/CanvasGroupy/sitemap.xml