New nbdev project

.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]

.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]

.gitignore

@@ -160,3 +160,7 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+
+# Added by Bhargav.
+_proc/

MANIFEST.in

@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

README.md

@@ -1,2 +1,67 @@
 # isl-2024
-Indian Super League, 2024
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+This file will become your README and also the index of your
+documentation.
+
+## Developer Guide
+
+If you are new to using `nbdev` here are some useful pointers to get you
+started.
+
+### Install isl_2024 in Development mode
+
+``` sh
+# make sure isl_2024 package is installed in development mode
+$ pip install -e .
+
+# make changes under nbs/ directory
+# ...
+
+# compile to have changes apply to isl_2024
+$ nbdev_prepare
+```
+
+## Usage
+
+### Installation
+
+Install latest from the GitHub
+[repository](https://github.com/bkowshik/isl-2024):
+
+``` sh
+$ pip install git+https://github.com/bkowshik/isl-2024.git
+```
+
+or from [conda](https://anaconda.org/bkowshik/isl-2024)
+
+``` sh
+$ conda install -c bkowshik isl_2024
+```
+
+or from [pypi](https://pypi.org/project/isl-2024/)
+
+``` sh
+$ pip install isl_2024
+```
+
+### Documentation
+
+Documentation can be found hosted on this GitHub
+[repository](https://github.com/bkowshik/isl-2024)’s
+[pages](https://bkowshik.github.io/isl-2024/). Additionally you can find
+package manager specific guidelines on
+[conda](https://anaconda.org/bkowshik/isl-2024) and
+[pypi](https://pypi.org/project/isl-2024/) respectively.
+
+## How to use
+
+Fill me in please! Don’t forget code examples:
+
+``` python
+1+1
+```
+
+    2

isl_2024/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

isl_2024/_modidx.py

@@ -0,0 +1,8 @@
+# Autogenerated by nbdev
+
+d = { 'settings': { 'branch': 'main',
+                'doc_baseurl': '/isl-2024',
+                'doc_host': 'https://bkowshik.github.io',
+                'git_url': 'https://github.com/bkowshik/isl-2024',
+                'lib_path': 'isl_2024'},
+  'syms': {'isl_2024.core': {'isl_2024.core.foo': ('core.html#foo', 'isl_2024/core.py')}}}

isl_2024/core.py

@@ -0,0 +1,9 @@
+"""Fill in a module description here"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_core.ipynb.
+
+# %% auto 0
+__all__ = ['foo']
+
+# %% ../nbs/00_core.ipynb 3
+def foo(): pass

nbs/00_core.ipynb

@@ -0,0 +1,61 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# core\n",
+    "\n",
+    "> Fill in a module description here"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| default_exp core"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| hide\n",
+    "from nbdev.showdoc import *"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| export\n",
+    "def foo(): pass"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| hide\n",
+    "import nbdev; nbdev.nbdev_export()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "python3",
+   "language": "python",
+   "name": "python3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

nbs/_quarto.yml

@@ -0,0 +1,22 @@
+project:
+  type: website
+
+format:
+  html:
+    theme: cosmo
+    css: styles.css
+    toc: true
+    keep-md: true
+  commonmark: default
+
+website:
+  twitter-card: true
+  open-graph: true
+  repo-actions: [issue]
+  navbar:
+    background: primary
+    search: true
+  sidebar:
+    style: floating
+
+metadata-files: [nbdev.yml, sidebar.yml]