Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI to build SVGs with images embedded #31

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/workflows/dist.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Update dist

on:
push:
branches:
- main
paths:
- 'images/experiments/**'
- '.github/workflows/dist.yml'
- 'scripts/embed_images.py'
schedule:
- cron: "30 2 * * *"
workflow_dispatch: ~

jobs:
update:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9'

- name: Update
run: python -u ./scripts/embed_images.py

- name: Get current time
run: echo "curr_time=$(date -uIs)" >> $GITHUB_ENV

- name: Push
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: dist
folder: dist
git-config-name: github-actions[bot]
git-config-email: 41898282+github-actions[bot]@users.noreply.github.com
commit-message: ${{ env.curr_time }}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.idea/
dist/
74 changes: 74 additions & 0 deletions scripts/embed_images.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
import re
import base64
from urllib import request
from http.client import HTTPResponse
from pathlib import Path
from functools import lru_cache
from typing import Optional, NoReturn


class Embedder:
_matcher = re.compile(r'(?<=xlink:href=")(https?://[^"]+)(?=")')

def __init__(self, matcher: re.Pattern = None):
self._matcher = matcher or self._matcher

@staticmethod
@lru_cache(maxsize=64)
def _fetch_remote(url: str) -> tuple[bytes, Optional[str]]:
print(f'Fetching {url}')
response: HTTPResponse
for _ in range(3):
try:
with request.urlopen(url, timeout=10) as response:
if response.status != 200:
raise Exception(f'{response.status} {response.reason}')
content_type = response.getheader('Content-Type')
print(f'Fetched {url} with content type {content_type}')
return response.read(), content_type
except Exception as e:
print(f'Failed to fetch {url}: {e}')
if _ == 2:
raise e

def _replacer(self, match: re.Match) -> str:
url = match.group(1)
data, content_type = self._fetch_remote(url)
data = base64.b64encode(data).decode()
content_type = content_type or 'image/png'
return f'data:{content_type};base64,{data}'

def embed(self, svg: str) -> str:
return self._matcher.sub(self._replacer, svg)

def __call__(self, source: Path, destination: Path) -> NoReturn:
print(f'Processing {source}')
svg = source.read_text()
svg = self.embed(svg)
print(f'Writing to {destination}')
destination.write_text(svg)


def main():
base_path = Path(__file__).parent.parent
dist_path = base_path / 'dist'
source_path = base_path / 'images' / 'experiments'

dist_path.mkdir(parents=True, exist_ok=True)

embeder = Embedder()

with (dist_path / 'README.md').open('w') as readme:
readme.write('# Dist\n\n')

for file in sorted(source_path.glob('*.svg')):
dest = dist_path / file.name
embeder(file, dest)
readme.write(
f'## [{file.name}]({file.name})\n\n'
f'[![{file.name}]({file.name})]({file.name})\n\n'
)


if __name__ == '__main__':
main()