init commit

Author: jph00

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

@@ -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

@@ -1,3 +1,25 @@
+posts/
+.quarto
+.sesskey
+*.db-*
+*.db
+.gitattributes
+_proc/
+sidebar.yml
+Gemfile.lock
+token
+_docs/
+conda/
+.last_checked
+.gitconfig
+*.bak
+*.log
+*~
+~*
+_tmp*
+tmp*
+tags
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -8,6 +30,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+env/
 build/
 develop-eggs/
 dist/
@@ -20,11 +43,9 @@ parts/
 sdist/
 var/
 wheels/
-share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
-MANIFEST
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -39,17 +60,13 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
-.nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
-*.py,cover
 .hypothesis/
-.pytest_cache/
-cover/
 
 # Translations
 *.mo
@@ -58,8 +75,6 @@ cover/
 # Django stuff:
 *.log
 local_settings.py
-db.sqlite3
-db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -72,63 +87,27 @@ instance/
 docs/_build/
 
 # PyBuilder
-.pybuilder/
 target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# IPython
-profile_default/
-ipython_config.py
-
 # pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
-.pdm.toml
-.pdm-python
-.pdm-build/
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
+.python-version
+
+# celery beat schedule file
 celerybeat-schedule
-celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
-# Environments
+# dotenv
 .env
+
+# virtualenv
 .venv
-env/
 venv/
 ENV/
-env.bak/
-venv.bak/
 
 # Spyder project settings
 .spyderproject
@@ -142,21 +121,32 @@ venv.bak/
 
 # mypy
 .mypy_cache/
-.dmypy.json
-dmypy.json
 
-# Pyre type checker
-.pyre/
+.vscode
+*.swp
+
+# osx generated files
+.DS_Store
+.DS_Store?
+.Trashes
+ehthumbs.db
+Thumbs.db
+.idea
+
+# pytest
+.pytest_cache
+
+# tools/trust-doc-nbs
+docs_src/.last_checked
+
+# symlinks to fastai
+docs_src/fastai
+tools/fastai
 
-# pytype static type analyzer
-.pytype/
+# link checker
+checklink/cookies.txt
 
-# Cython debug symbols
-cython_debug/
+# .gitconfig is now autogenerated
+.gitconfig
 
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  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/
+_docs

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 @@
 # fastcaddy
-A simple python wrapper for using the Caddy API
+
+
+<!-- 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 fastcaddy in Development mode
+
+``` sh
+# make sure fastcaddy package is installed in development mode
+$ pip install -e .
+
+# make changes under nbs/ directory
+# ...
+
+# compile to have changes apply to fastcaddy
+$ nbdev_prepare
+```
+
+## Usage
+
+### Installation
+
+Install latest from the GitHub
+[repository](https://github.com/AnswerDotAI/fastcaddy):
+
+``` sh
+$ pip install git+https://github.com/AnswerDotAI/fastcaddy.git
+```
+
+or from [conda](https://anaconda.org/AnswerDotAI/fastcaddy)
+
+``` sh
+$ conda install -c AnswerDotAI fastcaddy
+```
+
+or from [pypi](https://pypi.org/project/fastcaddy/)
+
+``` sh
+$ pip install fastcaddy
+```
+
+### Documentation
+
+Documentation can be found hosted on this GitHub
+[repository](https://github.com/AnswerDotAI/fastcaddy)’s
+[pages](https://AnswerDotAI.github.io/fastcaddy/). Additionally you can
+find package manager specific guidelines on
+[conda](https://anaconda.org/AnswerDotAI/fastcaddy) and
+[pypi](https://pypi.org/project/fastcaddy/) respectively.
+
+## How to use
+
+Fill me in please! Don’t forget code examples:
+
+``` python
+1+1
+```
+
+    2

fastcaddy/__init__.py

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

fastcaddy/_modidx.py

@@ -0,0 +1,24 @@
+# Autogenerated by nbdev
+
+d = { 'settings': { 'branch': 'main',
+                'doc_baseurl': '/fastcaddy',
+                'doc_host': 'https://AnswerDotAI.github.io',
+                'git_url': 'https://github.com/AnswerDotAI/fastcaddy',
+                'lib_path': 'fastcaddy'},
+  'syms': { 'fastcaddy.core': { 'fastcaddy.core.add_acme_config': ('core.html#add_acme_config', 'fastcaddy/core.py'),
+                                'fastcaddy.core.add_reverse_proxy': ('core.html#add_reverse_proxy', 'fastcaddy/core.py'),
+                                'fastcaddy.core.add_route': ('core.html#add_route', 'fastcaddy/core.py'),
+                                'fastcaddy.core.del_id': ('core.html#del_id', 'fastcaddy/core.py'),
+                                'fastcaddy.core.gcfg': ('core.html#gcfg', 'fastcaddy/core.py'),
+                                'fastcaddy.core.get_acme_config': ('core.html#get_acme_config', 'fastcaddy/core.py'),
+                                'fastcaddy.core.get_id': ('core.html#get_id', 'fastcaddy/core.py'),
+                                'fastcaddy.core.get_path': ('core.html#get_path', 'fastcaddy/core.py'),
+                                'fastcaddy.core.gid': ('core.html#gid', 'fastcaddy/core.py'),
+                                'fastcaddy.core.init_path': ('core.html#init_path', 'fastcaddy/core.py'),
+                                'fastcaddy.core.init_routes': ('core.html#init_routes', 'fastcaddy/core.py'),
+                                'fastcaddy.core.keys2path': ('core.html#keys2path', 'fastcaddy/core.py'),
+                                'fastcaddy.core.nested_setcfg': ('core.html#nested_setcfg', 'fastcaddy/core.py'),
+                                'fastcaddy.core.nested_setdict': ('core.html#nested_setdict', 'fastcaddy/core.py'),
+                                'fastcaddy.core.path2keys': ('core.html#path2keys', 'fastcaddy/core.py'),
+                                'fastcaddy.core.pcfg': ('core.html#pcfg', 'fastcaddy/core.py'),
+                                'fastcaddy.core.pid': ('core.html#pid', 'fastcaddy/core.py')}}}

fastcaddy/core.py

@@ -0,0 +1,138 @@
+"""Fill in a module description here"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_core.ipynb.
+
+# %% auto 0
+__all__ = ['acme_path', 'srvs_path', 'rts_path', 'get_id', 'get_path', 'gid', 'gcfg', 'pid', 'pcfg', 'nested_setdict',
+           'path2keys', 'keys2path', 'nested_setcfg', 'init_path', 'get_acme_config', 'add_acme_config', 'init_routes',
+           'add_route', 'add_reverse_proxy', 'del_id']
+
+# %% ../nbs/00_core.ipynb 4
+import os, subprocess, httpx, json
+from fastcore.utils import *
+from httpx import get as xget, post as xpost, patch as xpatch, put as xput, delete as xdelete, head as xhead
+
+# %% ../nbs/00_core.ipynb 6
+def get_id(path):
+    "Get a ID full URL from a path"
+    if path[0 ]!='/': path = '/'+path
+    if path[-1]!='/': path = path+'/'
+    return f'http://localhost:2019/id{path}'
+
+# %% ../nbs/00_core.ipynb 7
+def get_path(path):
+    "Get a config full URL from a path"
+    if path[0 ]!='/': path = '/'+path
+    if path[-1]!='/': path = path+'/'
+    return f'http://localhost:2019/config{path}'
+
+# %% ../nbs/00_core.ipynb 9
+def gid(path='/'):
+    "Gets the id at `path`"
+    response = xget(get_id(path))
+    response.raise_for_status()
+    return dict2obj(response.json())
+
+# %% ../nbs/00_core.ipynb 10
+def gcfg(path='/', method='get'):
+    "Gets the config at `path`"
+    f = getattr(httpx, method)
+    response = f(get_path(path))
+    response.raise_for_status()
+    return dict2obj(response.json())
+
+# %% ../nbs/00_core.ipynb 12
+def pid(d, path='/', method='post'):
+    "Puts the config `d` into `path`"
+    f = getattr(httpx, method)
+    response = f(get_id(path), json=obj2dict(d))
+    response.raise_for_status()
+    return response.text or None
+
+# %% ../nbs/00_core.ipynb 13
+def pcfg(d, path='/', method='post'):
+    "Puts the config `d` into `path`"
+    f = getattr(httpx, method)
+    response = f(get_path(path), json=obj2dict(d))
+    response.raise_for_status()
+    return response.text or None
+
+# %% ../nbs/00_core.ipynb 15
+def nested_setdict(sd, value, *keys):
+    "Returns `sd` updated to set `value` at the path `keys`"
+    d = sd
+    for key in keys[:-1]: d = d.setdefault(key, {})
+    d[keys[-1]] = value
+    return sd
+
+# %% ../nbs/00_core.ipynb 17
+def path2keys(path):
+    "Split `path` by '/' into a list"
+    return path.strip('/').split('/')
+
+# %% ../nbs/00_core.ipynb 19
+def keys2path(*keys):
+    "Join `keys` into a '/' separated path"
+    return '/'+'/'.join(keys)
+
+# %% ../nbs/00_core.ipynb 21
+def nested_setcfg(value, *keys):
+    d = nested_setdict(gcfg(), value, *keys)
+    return pcfg(d)
+
+# %% ../nbs/00_core.ipynb 22
+def init_path(path):
+    sp = []
+    for p in path2keys(path):
+        sp.append(p)
+        pcfg({}, keys2path(*sp))
+
+# %% ../nbs/00_core.ipynb 25
+acme_path = '/apps/tls/automation'
+def get_acme_config(token):
+    prov = { "provider": { "name": "cloudflare", "api_token": token } }
+    return {
+        "module": "acme",
+        "challenges": { "dns": prov }
+    }
+
+# %% ../nbs/00_core.ipynb 26
+def add_acme_config(cf_token):
+    init_path(acme_path)
+    val = [get_acme_config(cf_token)]
+    pcfg([{'issuers':val}], acme_path+'/policies')
+
+# %% ../nbs/00_core.ipynb 31
+srvs_path = '/apps/http/servers'
+rts_path = srvs_path+'/srv0/routes'
+
+# %% ../nbs/00_core.ipynb 32
+def init_routes(srv_name='srv0'):
+    # Create basic http server/routes config
+    init_path(srvs_path)
+    ir = {'listen': [':80', ':443'], 'routes': []}
+    pcfg(ir, f"{srvs_path}/{srv_name}")
+
+# %% ../nbs/00_core.ipynb 35
+def add_route(route):
+    "Add `route` dict to config"
+    return pcfg(route, rts_path)
+
+# %% ../nbs/00_core.ipynb 36
+def add_reverse_proxy(from_host, to_url):
+    "Create a reverse proxy handler"
+    route = {
+        "handle": [{
+            "handler": "reverse_proxy",
+            "upstreams": [{"dial": to_url}]
+        }],
+        "match": [{"host": [from_host]}],
+        "@id": from_host,
+        "terminal": True
+    }
+    add_route(route)
+
+# %% ../nbs/00_core.ipynb 41
+def del_id(id):
+    "Delete route for `id` (e.g. a host)"
+    xdelete(get_id(id))

nbs/00_core.ipynb

@@ -0,0 +1,21 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1527e0e0",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "python3",
+   "language": "python",
+   "name": "python3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

nbs/Untitled.ipynb

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

nbs/_quarto.yml

@@ -0,0 +1,339 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#| hide\n",
+    "from fastcaddy.core import *"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# fastcaddy\n",
+    "\n",
+    "> A simple python wrapper for using the caddy API"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Usage"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Installation"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Install from [pypi][pypi]\n",
+    "\n",
+    "\n",
+    "```sh\n",
+    "$ pip install fastcaddy\n",
+    "```\n",
+    "\n",
+    "[pypi]: https://pypi.org/project/fastcaddy/"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Installing Caddy"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from fastcore.utils import *"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This project is to help you use the caddy API, rather than a Caddyfile, to use caddy. To use the API, you need to install a plugin for your domain management service. We use Cloudflare, so we'll document that here. For other domain services, see the Caddy docs for other plugins."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Cloudflare setup"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You'll need a token from Cloudflare with access to modify the necessary settings. Here's the steps to create a token with the minimal privileges. You'll need to install the cloudflare pip package, then import:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from cloudflare import Cloudflare"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Then you'll need create a Cloudflare API token for your user, which we'll then use to create the less privileged token."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cf_token = os.environ['CLOUDFLARE_API_TOKEN']"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We can now check that works OK:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "8"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "cf = Cloudflare(api_token=cf_token)\n",
+    "zones = cf.zones.list()\n",
+    "len(zones.result)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Replace this with your domain name:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "domain = 'answer.ai'\n",
+    "zones = cf.zones.list(name=domain)\n",
+    "assert len(zones.result)==1"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "zone_id = zones.result[0].id"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Here's the methods available for modifying DNS records:\n",
+    "\n",
+    "- `client.dns.records.create(*, zone_id, **params) -> Optional`\n",
+    "- `client.dns.records.update(dns_record_id, *, zone_id, **params) -> Optional`\n",
+    "- `client.dns.records.list(*, zone_id, **params) -> SyncV4PagePaginationArray[Record]`\n",
+    "- `client.dns.records.delete(dns_record_id, *, zone_id) -> Optional`\n",
+    "- `client.dns.records.edit(dns_record_id, *, zone_id, **params) -> Optional`\n",
+    "- `client.dns.records.export(*, zone_id) -> str`\n",
+    "- `client.dns.records.get(dns_record_id, *, zone_id) -> Optional`\n",
+    "- `client.dns.records.import\\_(*, zone_id, **params) -> Optional`\n",
+    "- `client.dns.records.scan(*, zone_id, **params) -> Optional`"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "…and here's the methods for tokens:\n",
+    "\n",
+    "```python\n",
+    "from cloudflare.types.user import (CIDRList, Policy, Token, TokenCreateResponse, TokenUpdateResponse, TokenListResponse,\n",
+    "                                   TokenDeleteResponse, TokenGetResponse, TokenVerifyResponse)\n",
+    "```\n",
+    "\n",
+    "- `client.user.tokens.create(**params) -> Optional`\n",
+    "- `client.user.tokens.update(token_id, **params) -> object`\n",
+    "- `client.user.tokens.list(**params) -> SyncV4PagePaginationArray[object]`\n",
+    "- `client.user.tokens.delete(token_id) -> Optional`\n",
+    "- `client.user.tokens.get(token_id) -> object`\n",
+    "- `client.user.tokens.verify() -> Optional`\n",
+    "\n",
+    "```python\n",
+    "from cloudflare.types.user.tokens import PermissionGroupListResponse\n",
+    "```\n",
+    "\n",
+    "- client.user.tokens.permission_groups.list() -> SyncSinglePage[object]\n",
+    "\n",
+    "```python\n",
+    "from cloudflare.types.user.tokens import Value\n",
+    "```\n",
+    "\n",
+    "- client.user.tokens.value.update(token_id, **params) -> str"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We need these two permissions in our token:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "permission_groups = cf.user.tokens.permission_groups.list()\n",
+    "\n",
+    "dns_write = next(group for group in permission_groups if group['name'] == 'DNS Write')\n",
+    "zone_read = next(group for group in permission_groups if group['name'] == 'Zone Read')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Now we can create it:\n",
+    "\n",
+    "```python\n",
+    "new_token = cf.user.tokens.create(\n",
+    "    name='caddy_dns',\n",
+    "    policies=[{\n",
+    "        \"effect\": \"allow\",\n",
+    "        \"resources\": { f\"com.cloudflare.api.account.zone.{zone_id}\": \"*\" },\n",
+    "        \"permission_groups\": [\n",
+    "            {\"id\": zone_read['id'], \"name\": \"Zone Read\"},\n",
+    "            {\"id\": dns_write['id'], \"name\": \"DNS Write\"}\n",
+    "        ]\n",
+    "    }]\n",
+    ")\n",
+    "\n",
+    "print(new_token.value)\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Make a copy of this value, which we'll need for setting up caddy."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Installing caddy"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "To install caddy, we'll use a tool called `xcaddy`. This is written in go. So first install go:\n",
+    "\n",
+    "- Mac: `brew install go`\n",
+    "- Linux: `sudo apt install golang`\n",
+    "\n",
+    "Now we can install xcaddy:\n",
+    "\n",
+    "```sh\n",
+    "go install github.com/caddyserver/xcaddy/cmd/xcaddy@latest\n",
+    "```\n",
+    "\n",
+    "Then we use that to compile caddy with our desired domain plugin (cloudflare, in this case):\n",
+    "\n",
+    "```sh\n",
+    "cd ~/go/bin\n",
+    "./xcaddy build --with github.com/caddy-dns/cloudflare\n",
+    "```\n",
+    "\n",
+    "This gives us a `~/go/bin/caddy` binary we can run:\n",
+    "\n",
+    "```sh\n",
+    "./caddy run\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Auto-run caddy on start"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "If you're using a server or running caddy a lot, you'll want it to run on start. This isn't needed otherwise -- you can just `~/go/bin/caddy run` to run it manually (you may want to add `~/go/bin` to your `PATH` env var)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## How to use"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "python3",
+   "language": "python",
+   "name": "python3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

nbs/index.ipynb

@@ -0,0 +1,9 @@
+project:
+  output-dir: _docs
+
+website:
+  title: "fastcaddy"
+  site-url: "https://AnswerDotAI.github.io/fastcaddy"
+  description: "A simple python wrapper for using the Caddy API"
+  repo-branch: main
+  repo-url: "https://github.com/AnswerDotAI/fastcaddy"

nbs/nbdev.yml

@@ -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%;
+}

nbs/styles.css

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=64.0"]
+build-backend = "setuptools.build_meta"

pyproject.toml

@@ -0,0 +1,45 @@
+[DEFAULT]
+# All sections below are required unless otherwise specified.
+# See https://github.com/fastai/nbdev/blob/master/settings.ini for examples.
+
+### Python library ###
+repo = fastcaddy
+lib_name = %(repo)s
+version = 0.0.1
+min_python = 3.7
+license = apache2
+black_formatting = False
+
+### nbdev ###
+doc_path = _docs
+lib_path = fastcaddy
+nbs_path = nbs
+recursive = True
+tst_flags = notest
+put_version_in_init = True
+
+### Docs ###
+branch = main
+custom_sidebar = False
+doc_host = https://%(user)s.github.io
+doc_baseurl = /%(repo)s
+git_url = https://github.com/%(user)s/%(repo)s
+title = %(lib_name)s
+
+### PyPI ###
+audience = Developers
+author = Jeremy Howard
+author_email = github@jhoward.fastmail.fm
+copyright = 2024 onwards, %(author)s
+description = A simple python wrapper for using the Caddy API
+keywords = nbdev jupyter notebook python
+language = English
+status = 3
+user = AnswerDotAI
+
+### Optional ###
+# requirements = fastcore pandas
+# dev_requirements = 
+# console_scripts =
+# conda_user = 
+# package_data =

settings.ini

@@ -0,0 +1,64 @@
+from pkg_resources import parse_version
+from configparser import ConfigParser
+import setuptools, shlex
+assert parse_version(setuptools.__version__)>=parse_version('36.2')
+
+# note: all settings are in settings.ini; edit there, not here
+config = ConfigParser(delimiters=['='])
+config.read('settings.ini', encoding='utf-8')
+cfg = config['DEFAULT']
+
+cfg_keys = 'version description keywords author author_email'.split()
+expected = cfg_keys + "lib_name user branch license status min_python audience language".split()
+for o in expected: assert o in cfg, "missing expected setting: {}".format(o)
+setup_cfg = {o:cfg[o] for o in cfg_keys}
+
+licenses = {
+    'apache2': ('Apache Software License 2.0','OSI Approved :: Apache Software License'),
+    'mit': ('MIT License', 'OSI Approved :: MIT License'),
+    'gpl2': ('GNU General Public License v2', 'OSI Approved :: GNU General Public License v2 (GPLv2)'),
+    'gpl3': ('GNU General Public License v3', 'OSI Approved :: GNU General Public License v3 (GPLv3)'),
+    'bsd3': ('BSD License', 'OSI Approved :: BSD License'),
+}
+statuses = [ '1 - Planning', '2 - Pre-Alpha', '3 - Alpha',
+    '4 - Beta', '5 - Production/Stable', '6 - Mature', '7 - Inactive' ]
+py_versions = '3.6 3.7 3.8 3.9 3.10 3.11 3.12'.split()
+
+requirements = shlex.split(cfg.get('requirements', ''))
+if cfg.get('pip_requirements'): requirements += shlex.split(cfg.get('pip_requirements', ''))
+min_python = cfg['min_python']
+lic = licenses.get(cfg['license'].lower(), (cfg['license'], None))
+dev_requirements = (cfg.get('dev_requirements') or '').split()
+
+package_data = dict()
+pkg_data = cfg.get('package_data', None)
+if pkg_data:
+    package_data[cfg['lib_name']] =  pkg_data.split() # split as multiple files might be listed
+# Add package data to setup_cfg for setuptools.setup(..., **setup_cfg)
+setup_cfg['package_data'] = package_data
+
+setuptools.setup(
+    name = cfg['lib_name'],
+    license = lic[0],
+    classifiers = [
+        'Development Status :: ' + statuses[int(cfg['status'])],
+        'Intended Audience :: ' + cfg['audience'].title(),
+        'Natural Language :: ' + cfg['language'].title(),
+    ] + ['Programming Language :: Python :: '+o for o in py_versions[py_versions.index(min_python):]] + (['License :: ' + lic[1] ] if lic[1] else []),
+    url = cfg['git_url'],
+    packages = setuptools.find_packages(),
+    include_package_data = True,
+    install_requires = requirements,
+    extras_require={ 'dev': dev_requirements },
+    dependency_links = cfg.get('dep_links','').split(),
+    python_requires  = '>=' + cfg['min_python'],
+    long_description = open('README.md', encoding='utf-8').read(),
+    long_description_content_type = 'text/markdown',
+    zip_safe = False,
+    entry_points = {
+        'console_scripts': cfg.get('console_scripts','').split(),
+        'nbdev': [f'{cfg.get("lib_path")}={cfg.get("lib_path")}._modidx:d']
+    },
+    **setup_cfg)
+
+