Skip to content

Add analytics template and update config for Beemo 0.4.0 #4

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.

Sign up for GitHub

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

Merged
bennuttall merged 1 commit into from
Apr 9, 2026
Merged

Add analytics template and update config for Beemo 0.4.0 #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,5 @@ jobs:
env:
BEEMO_CONFIG: config.yml
run: |
mkdir www
python scripts/pyjokes_to_js.py
beemo
beemo build
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
www
apache2
csv
analytics
.DS_Store
poetry.lock
17 changes: 15 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
export BEEMO_CONFIG=config.yml

.PHONY: build logs analytics serve serve-analytics

build:
python scripts/pyjokes_to_js.py
rm -rf www && mkdir -p www
BEEMO_CONFIG=config.yml beemo
BEEMO_CONFIG=$(BEEMO_CONFIG) beemo build

logs:
BEEMO_CONFIG=$(BEEMO_CONFIG) beemo logs

analytics:
BEEMO_CONFIG=$(BEEMO_CONFIG) beemo analytics

serve:
python -m http.server -d www 8008 &
python -m http.server -d www 8000

serve-analytics:
python -m http.server -d analytics 8000
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ built using a static site generator called [beemo](https://github.com/bennuttall
This repo contains content, static files and
[Chameleon](https://chameleon.readthedocs.io/en/latest/) templates for the pyjokes website.

## Build

Requires [beemo](https://github.com/bennuttall/beemo) with the `logs` extra installed.

```bash
make build # generate JS and build the site
make logs # process Apache logs into CSV
make analytics # generate analytics report
make serve # serve the site locally on port 8008
make serve-analytics # serve the analytics report on port 8009
```

## Licences

The site content is copyright Pyjokes Society.
Expand Down
17 changes: 14 additions & 3 deletions config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
pages_dir: pages
static_dir: static
templates_dir: templates
output_dir: www
csv_dir: csv

build:
pages_dir: pages
static_dir: static
output_dir: www

logs:
logs_dir: apache2
pattern: "pyjok.es-access*"

analytics:
output_dir: analytics
base_url: https://pyjok.es
281 changes: 281 additions & 0 deletions templates/analytics.pt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>${title}</title>
<script src="https://cdn.jsdelivr.net/npm/chart.js@4"></script>
<style>
* { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: system-ui, sans-serif; background: #f5f5f5; color: #222; padding: 2rem; }
.container { width: 640px; margin: 0 auto; }
h1 { font-size: 1.5rem; margin-bottom: 1.5rem; }
.cards { display: flex; gap: 1rem; margin-bottom: 2rem; flex-wrap: wrap; }
.card { background: #fff; border-radius: 8px; padding: 1.25rem 1.75rem; box-shadow: 0 1px 3px rgba(0,0,0,.1); }
.card .value { font-size: 2rem; font-weight: 700; }
.card .label { font-size: .85rem; color: #666; margin-top: .2rem; }
.panel { background: #fff; border-radius: 8px; padding: 1.25rem; box-shadow: 0 1px 3px rgba(0,0,0,.1); margin-bottom: 1.5rem; }
.panel h2 { font-size: 1rem; margin-bottom: 1rem; color: #444; }
table { width: 100%; border-collapse: collapse; font-size: .9rem; }
th { text-align: left; padding: .4rem .6rem; border-bottom: 2px solid #eee; color: #666; font-weight: 600; }
th:last-child { width: 4rem; }
td { padding: .4rem .6rem; border-bottom: 1px solid #f0f0f0; vertical-align: middle; }
td:last-child { color: #555; white-space: nowrap; }
tr:last-child td { border-bottom: none; }
.page-title { font-weight: 500; }
.page-path { font-size: .8rem; color: #888; }
.badge { display: inline-block; font-size: .7rem; padding: .1rem .4rem; border-radius: 3px; color: #fff; vertical-align: middle; margin-left: .4rem; }
tfoot td { border-bottom: none; padding: .5rem .6rem; }
.expand-btn { background: none; border: none; color: #4f81c7; cursor: pointer; font-size: .85rem; padding: 0; text-decoration: underline; }
.expand-btn:hover { color: #2a5a9f; }
.ext-link { color: #bbb; text-decoration: none; vertical-align: middle; margin-left: .2rem; }
.ext-link:hover { color: #4f81c7; }
.ref-link { color: #222; text-decoration: none; }
.ref-link:hover { text-decoration: underline; }
nav { margin-bottom: 1.5rem; }
.breadcrumbs { font-size: .85rem; color: #888; margin-bottom: .6rem; }
.breadcrumbs a { color: #4f81c7; text-decoration: none; }
.breadcrumbs a:hover { text-decoration: underline; }
.breadcrumbs span + span::before { content: " / "; color: #ccc; }
.nav-links { display: flex; gap: .5rem; flex-wrap: wrap; }
.nav-links a { background: #fff; border-radius: 6px; padding: .3rem .8rem; font-size: .85rem; color: #4f81c7; text-decoration: none; box-shadow: 0 1px 3px rgba(0,0,0,.1); }
.nav-links a:hover { background: #4f81c7; color: #fff; }
.nav-links a.current { background: #4f81c7; color: #fff; pointer-events: none; }
.prev-next { display: flex; justify-content: space-between; margin-top: .6rem; font-size: .85rem; }
.prev-next a { color: #4f81c7; text-decoration: none; }
.prev-next a:hover { text-decoration: underline; }
</style>
</head>
<body>
<div class="container">

<nav>
<div class="breadcrumbs" tal:condition="nav['breadcrumbs']">
<span tal:repeat="crumb nav['breadcrumbs']"><a tal:attributes="href crumb['url']">${crumb['label']}</a></span>
</div>
<div class="nav-links" tal:condition="nav.get('years')">
<a tal:repeat="item nav['years']"
tal:attributes="href item['url']; class python: 'current' if item.get('current') else None">${item['label']}</a>
</div>
<div class="nav-links" tal:condition="nav.get('months')" tal:attributes="style python: 'margin-top: .5rem' if nav.get('years') else None">
<a tal:repeat="item nav['months']"
tal:attributes="href item['url']; class python: 'current' if item.get('current') else None">${item['label']}</a>
</div>
<div class="prev-next" tal:condition="python: nav.get('prev') or nav.get('next')">
<a tal:condition="nav.get('prev')" tal:attributes="href nav['prev']['url']">&larr; ${nav['prev']['label']}</a>
<span tal:condition="not: nav.get('prev')"></span>
<a tal:condition="nav.get('next')" tal:attributes="href nav['next']['url']">${nav['next']['label']} &rarr;</a>
</div>
</nav>

<h1>${title}</h1>

<tal:block tal:define="
fmt python: lambda d: datetime.strptime(d, '%Y-%m-%d').strftime('%-d %B %Y');
date_range python: fmt(report['date_from']) if report['date_from'] == report['date_to'] else fmt(report['date_from']) + ' \u2013 ' + fmt(report['date_to']);
base python: report['base_url'].rstrip('/')
">
<div class="cards">
<div class="card"><div class="value" tal:content="python: '{:,}'.format(report['total_hits'])">0</div><div class="label">Total hits</div></div>
<div class="card"><div class="value" tal:content="python: '{:.1f}%'.format(report['bot_hits'])">0%</div><div class="label">Bot hits</div></div>
<div class="card"><div class="value" tal:content="python: '{:,}'.format(report['unique_ips'])">0</div><div class="label">Unique IPs</div></div>
<div class="card"><div class="value">${date_range}</div><div class="label">Date range</div></div>
</div>
</tal:block>

<div class="panel">
<h2>Hits by month</h2>
<canvas id="monthChart"></canvas>
</div>

<div class="panel">
<h2>Hits by day</h2>
<canvas id="dayChart"></canvas>
</div>

<!-- Pages -->
<div class="panel" tal:condition="report['sections']['page']" tal:define="entries report['sections']['page']; top entries[:10]; rest entries[10:20]">
<h2>Pages</h2>
<table>
<thead><tr><th>Page</th><th>Hits</th></tr></thead>
<tbody>
<tr tal:repeat="p top" tal:define="base report['base_url'].rstrip('/')">
<td>
<span class="page-title">${p['title']}</span>
<a tal:condition="base" tal:attributes="href base + p['path']" target="_blank" rel="noopener" class="ext-link">&#8599;</a>
<br /><span class="page-path">${p['path']}</span>
</td>
<td tal:content="python: '{:,}'.format(p['hits'])">0</td>
</tr>
</tbody>
<tbody class="more" hidden="hidden" tal:condition="rest">
<tr tal:repeat="p rest" tal:define="base report['base_url'].rstrip('/')">
<td>
<span class="page-title">${p['title']}</span>
<a tal:condition="base" tal:attributes="href base + p['path']" target="_blank" rel="noopener" class="ext-link">&#8599;</a>
<br /><span class="page-path">${p['path']}</span>
</td>
<td tal:content="python: '{:,}'.format(p['hits'])">0</td>
</tr>
</tbody>
<tfoot tal:condition="rest">
<tr><td colspan="2">
<button class="expand-btn" onclick="toggleMore(this)" tal:content="python: f'Show {len(rest)} more'">Show more</button>
</td></tr>
</tfoot>
</table>
</div>

<!-- Posts -->
<div class="panel" tal:condition="report['sections']['post']" tal:define="entries report['sections']['post']; top entries[:10]; rest entries[10:20]">
<h2>Posts</h2>
<table>
<thead><tr><th>Post</th><th>Hits</th></tr></thead>
<tbody>
<tr tal:repeat="p top" tal:define="base report['base_url'].rstrip('/')">
<td>
<span class="page-title">${p['title']}</span>
<a tal:condition="base" tal:attributes="href base + p['path']" target="_blank" rel="noopener" class="ext-link">&#8599;</a>
<br /><span class="page-path">${p['path']}</span>
</td>
<td tal:content="python: '{:,}'.format(p['hits'])">0</td>
</tr>
</tbody>
<tbody class="more" hidden="hidden" tal:condition="rest">
<tr tal:repeat="p rest" tal:define="base report['base_url'].rstrip('/')">
<td>
<span class="page-title">${p['title']}</span>
<a tal:condition="base" tal:attributes="href base + p['path']" target="_blank" rel="noopener" class="ext-link">&#8599;</a>
<br /><span class="page-path">${p['path']}</span>
</td>
<td tal:content="python: '{:,}'.format(p['hits'])">0</td>
</tr>
</tbody>
<tfoot tal:condition="rest">
<tr><td colspan="2">
<button class="expand-btn" onclick="toggleMore(this)" tal:content="python: f'Show {len(rest)} more'">Show more</button>
</td></tr>
</tfoot>
</table>
</div>

<!-- Other (tags, archive, index) -->
<div class="panel" tal:condition="report['sections']['other']" tal:define="
entries report['sections']['other'];
top entries[:10];
rest entries[10:20];
badge_colours python: {'tag': '#e0a060', 'archive': '#a06090', 'index': '#888'}
">
<h2>Other</h2>
<table>
<thead><tr><th>Page</th><th>Hits</th></tr></thead>
<tbody>
<tr tal:repeat="p top" tal:define="base report['base_url'].rstrip('/')">
<td>
<span class="page-title">${p['title']}</span>
<a tal:condition="base" tal:attributes="href base + p['path']" target="_blank" rel="noopener" class="ext-link">&#8599;</a>
<span class="badge"
tal:define="colour python: badge_colours.get(p['type'], '#888')"
tal:attributes="style python: 'background:' + colour"
tal:content="p['type']">type</span>
<br /><span class="page-path">${p['path']}</span>
</td>
<td tal:content="python: '{:,}'.format(p['hits'])">0</td>
</tr>
</tbody>
<tbody class="more" hidden="hidden" tal:condition="rest">
<tr tal:repeat="p rest" tal:define="base report['base_url'].rstrip('/')">
<td>
<span class="page-title">${p['title']}</span>
<a tal:condition="base" tal:attributes="href base + p['path']" target="_blank" rel="noopener" class="ext-link">&#8599;</a>
<span class="badge"
tal:define="colour python: badge_colours.get(p['type'], '#888')"
tal:attributes="style python: 'background:' + colour"
tal:content="p['type']">type</span>
<br /><span class="page-path">${p['path']}</span>
</td>
<td tal:content="python: '{:,}'.format(p['hits'])">0</td>
</tr>
</tbody>
<tfoot tal:condition="rest">
<tr><td colspan="2">
<button class="expand-btn" onclick="toggleMore(this)" tal:content="python: f'Show {len(rest)} more'">Show more</button>
</td></tr>
</tfoot>
</table>
</div>

<!-- Referring sites -->
<div class="panel" tal:define="counts report['referer_counts']; top counts[:10]; rest counts[10:20]">
<h2>Referring sites</h2>
<table>
<thead><tr><th>Domain</th><th>Hits</th></tr></thead>
<tbody>
<tr tal:repeat="item top">
<td><a tal:attributes="href 'https://' + item[0]" target="_blank" rel="noopener" class="ref-link">${item[0]} &#8599;</a></td>
<td tal:content="python: '{:,}'.format(item[1])">0</td>
</tr>
</tbody>
<tbody class="more" hidden="hidden" tal:condition="rest">
<tr tal:repeat="item rest">
<td><a tal:attributes="href 'https://' + item[0]" target="_blank" rel="noopener" class="ref-link">${item[0]} &#8599;</a></td>
<td tal:content="python: '{:,}'.format(item[1])">0</td>
</tr>
</tbody>
<tfoot tal:condition="rest">
<tr><td colspan="2">
<button class="expand-btn" onclick="toggleMore(this)" tal:content="python: f'Show {len(rest)} more'">Show more</button>
</td></tr>
</tfoot>
</table>
</div>

<!-- User agents -->
<div class="panel">
<h2>User agents</h2>
<canvas id="uaChart"></canvas>
</div>

</div>

<script>
new Chart(document.getElementById('monthChart'), {
type: 'bar',
data: {
labels: <tal:block replace="structure python: json.dumps([datetime.strptime(m, '%Y-%m').strftime('%B %Y') for m in report['months']])" />,
datasets: [{ data: <tal:block replace="structure json.dumps(report['hits_by_month'])" />, backgroundColor: '#4f81c7', borderRadius: 3 }]
},
options: { plugins: { legend: { display: false } }, scales: { y: { beginAtZero: true } } }
});

new Chart(document.getElementById('dayChart'), {
type: 'bar',
data: {
labels: <tal:block replace="structure python: json.dumps([datetime.strptime(d, '%Y-%m-%d').strftime('%-d %B') for d in report['dates']])" />,
datasets: [{ data: <tal:block replace="structure json.dumps(report['hits_by_day'])" />, backgroundColor: '#4f81c7', borderRadius: 3 }]
},
options: { plugins: { legend: { display: false } }, scales: { y: { beginAtZero: true } } }
});

new Chart(document.getElementById('uaChart'), {
type: 'bar',
data: {
labels: <tal:block replace="structure python: json.dumps([item['ua'] for item in report['ua_counts']])" />,
datasets: [{ data: <tal:block replace="structure python: json.dumps([item['hits'] for item in report['ua_counts']])" />, backgroundColor: <tal:block replace="structure python: json.dumps(['#aaa' if item['is_bot'] else '#4f81c7' for item in report['ua_counts']])" />, borderRadius: 3 }]
},
options: {
indexAxis: 'y',
plugins: { legend: { display: false } },
scales: { x: { beginAtZero: true } }
}
});

function toggleMore(btn) {
const more = btn.closest('table').querySelector('.more');
const hidden = more.hidden;
more.hidden = !hidden;
btn.textContent = hidden ? 'Show less' : 'Show ' + more.rows.length + ' more';
}
</script>
</body>
</html>