CHANGELOG.md

Changelog

All notable changes to this project will be documented here.

The format is based on Keep a Changelog, and this project attempts to adhere to Semantic Versioning.

v0.9.0 (2024-07-20)

💄 Styling

• change support image (795a860)

🐛 Bug Fixes

• correct usage of together v1.2.x completions API (4d5c7a6)
• deps: update dependency boto3 to v1.34.145 (c232eda)
• deps: update dependency ua-parser-js to v1.0.38 (c9616dc)
• use together v1.2.x and the Chat interface (415c7fd)

📝 Docs

• add diagram that illustrates how the whole thing works (f4582f3)
• update news sources (7d6fe82)

👷 CI/CD

• bump schneegans/dynamic-badges-action to v1.7.0 (fd122b4)
• ensure TOGETHER_API_KEY environment variable exists (fa71dad)
• improve CI (aaeaf67)

🚀 Features

• apply Dynamic Range Compression (280e1d4)
• improve audio quality and only use 1 audio file for background music (d8b2131)
• the one where Ayanda returns from her hiatus (e775906)
• use meta-llama/Llama-3-70b-chat-hf (12fbe27)

✅ Tests

• update tests in light of d8b2131, 3166486 and 280e1d4 (070d3ff)

♻️ Code Refactoring

• bump summary limits (0c33424)
• change intro and outro music (ab3877f)
• darken overlay, brighten txt, use smaller & more apt bg image (66880b5)
• switch from Google Podcasts to Spotify (4313912)
• update some text on about page (35ef4bb)
• update transcript creation prompt (544f30c)
• use actual podcast transcript to generate description (3166486)
• use older/newer instead of next/previous (d685379)
• we no longer need to specify version in docker compose config (0d48eb0)

⚙️ Build System

• bump Node.js to version 18 (8ac7d09)
• bump poetry to 1.8.3 (7d4a871)
• deps-dev: update dependency eslint to v8.57.0 (#92) (0f9ab59)
• deps-dev: update dependency eslint-config-prettier to v8.10.0 (#93) (7dd8528)
• deps-dev: update dependency eslint-webpack-plugin to v4.2.0 (#94) (37f5d44)
• deps-dev: update dependency mini-css-extract-plugin to v2.9.0 (#95) (b7dbe51)
• deps: replace dependency npm-run-all with npm-run-all2 ^5.0.0 (#69) (02c9b22)
• deps: update dependency bootstrap to v5.3.3 (#71) (42b92b9)
• deps: update dependency boto3 to v1.34.136 (#72) (5932716)
• deps: update dependency commitizen to v3.27.0 (#75) (bc1e505)
• deps: update dependency commitizen to v3.28.0 (#91) (ed3fd4d)
• deps: update dependency css-loader to v6.11.0 (#86) (a6d8955)
• deps: update dependency cssnano to v6.1.2 (#76) (a77a048)
• deps: update dependency del to v7.1.0 (#77) (beca01c)
• deps: update dependency dotenv to v16.4.5 (#87) (445744f)
• deps: update dependency jinja2 to v3.1.4 (#83) (32faf57)
• deps: update dependency peewee to v3.17.5 (#73) (1b5d917)
• deps: update dependency peewee to v3.17.6 (#88) (7324a49)
• deps: update dependency postcss to v8.4.39 (#70) (5dea587)
• deps: update dependency python-dotenv to v1.0.1 (#74) (5c6cd1a)
• deps: update dependency requests to v2.32.2 [security] (#78) (bc12059)
• deps: update dependency sharer.js to v0.5.2 (#89) (5fb25aa)
• deps: update dependency together to v1.2.2 (#90) (19d7649)
• remove html-minifier because of security vulnerabilities (b89bd99)
• update black (23.12.1 -> 24.4.2) (9d7619b)
• update certifi (2023.5.7 -> 2024.7.4) (ffa96fa)
• update idna (3.4 -> 3.7) (9db73ee)
• update langchain (0.0.353 -> 0.2.10) (da3a9f9)
• update requests (2.31.0 -> 2.32.3) (aaf5bbb)
• update ruff (0.0.291 -> 0.5.3) (7b767ba)
• update setuptools (67.8.0 -> 71.0.4) (f099997)
• update transformers (4.36.2 -> 4.42.4) (02f4011)
• update urllib3 (1.26.16 -> 2.2.2) (7b83a7f)
• update zipp (3.15.0 -> 3.19.2) (6b512e0)

v0.8.0 (2024-06-30)

♻️ Code Refactoring

• back to the way things were before df1e8b1 (8809a63)
• use default repetition penalty (5cf615f)

🚀 Features

• add Times of Zambia (e5366f9)

🐛 Bug Fixes

• new lines (f18949d)
• remove www from znbc URL (6d0956b)
• rendering of podcast description in template (bdb12eb)

v0.7.0 (2024-03-25)

✅ Tests

• fix broken test (d077ff5)

🚀 Features

• add a better description of each podcast (fbfe3db)
• add title and description to the uploaded video (0e2f6c1)
• do not use the same image overlay everytime (4f66c53)
• make the LLM more creative (df1e8b1)

🐛 Bug Fixes

• correct broken YAML in episode 196 Nunjucks template (adf5e93)
• description formatting in 2024-03-18.njk (b03e33f)
• ensure we don't have empy description (c1b40c3)
• iensure that the description has no newlines (438b71c)
• use the correct path for the images (f181b20)
• yet another description formatting correction (97150f0)

♻️ Code Refactoring

• minimise social noise (8dda93e)
• the creativity is too much (cf4c8b0)

⚙️ Build System

• deps: update babel monorepo (#58) (686a762)
• deps: update dependency beautifulsoup4 to v4.12.3 (#61) (74732fb)
• deps: update dependency boto3 to v1.34.70 (#62) (033d5c9)
• deps: update dependency core-js to v3.36.1 (#66) (ae04a47)
• deps: update dependency css-loader to v6.10.0 (#67) (b51216b)
• deps: update dependency jinja2 to v3.1.3 (#63) (2c703de)
• deps: update dependency mini-css-extract-plugin to v2.8.1 (#60) (267261e)
• deps: update dependency together to v0.2.11 (#64) (6bf55dc)

v0.6.0 (2024-02-14)

⚙️ Build System

• deps: update dependency black to v23.12.1 (#59) (6643a9a)
• deps: update dependency boto3 to v1.34.19 (#54) (3138c19)
• deps: update dependency cssnano to v6.0.3 (#51) (ee75d90)
• deps: update dependency postcss to v8.4.33 (#52) (487d9ad)
• deps: update dependency sass-loader to v13.3.3 (#53) (c0baa61)
• deps: update dependency torch to v2.1.2 (#55) (b31dff3)
• deps: update dependency transformers to v4.36.2 (#56) (2c5d47d)
• deps: update dependency ua-parser-js to v1.0.37 (#57) (acbbfe8)

♻️ Code Refactoring

• ensure social posts don't start with Facebook Post: (4e5f6a6)
• go back to using mistralai/Mixtral-8x7B-Instruct-v0.1 for social posts (05cbf07)
• simplify social share prompt & switch to Platypus2-70B-instruct (80ebde2)

🐛 Bug Fixes

• add a quick fix to handle connection errors for ZNBC (710f46c)
• address the too many articles problem (79ee3aa)
• correct the buggy fix in 710f46c (64be24d)
• remove baclticks in social post and correct conditional statements (b078422)
• simplify pagination (56b1217)
• use the correct font and adjust text duration (e22ca82)

🚀 Features

• create facebook post accompanied by video (f7a7a73)
• create video and post to facebook (f5c807f)
• use openchat/openchat-3.5-1210 for social posts (3bea658)
• use Qwen/Qwen1.5-14B-Chat for the transcript (b43e5f7)
• use the NousResearch/Nous-Hermes-2-Mixtral-8x7B-SFT model (1d6ffdb)

v0.5.0 (2024-01-02)

✅ Tests

• mock together summarisation backend (ca7b9ac)
• temporarily remove failing test and exercise caution with bs4 (f76b321)

🚀 Features

• install replicate (40c12ba)
• let the LLM actually present the podcast (d0e63b3)
• use together.ai & bump langchain to 0.0.348 (63e68e7)
• use vicuna-13b-v1.5-16k and garage-bAInd/Platypus2-70B-instruct (16e2877)

♻️ Code Refactoring

• change prompt and do not use one-sentence summary (5b0ad43)
• tweak the content generation (c1b6237)
• tweak the together.ai invocation (39199f1)
• update codebase to incorporate new ORM (8d2fa06)
• yet another small tweak (b81538c)

👷 CI/CD

• deps: update sosedoff/pgweb docker tag to v0.14.2 (daf654d)

🐛 Bug Fixes

• deps: update dependency num2words to v0.5.13 (#50) (d9c1593)
• ensure that import_db_dump task works correctly (c13067f)
• erroneous transcript generation (0fdb6c9)

⚙️ Build System

• deps: update dependency babel-loader to v9.1.3 (#43) (fd4f110)
• deps: update dependency bootstrap to v5.3.2 (#47) (df4d544)
• deps: update dependency boto3 to v1.34.11 (#32) (43b6536)
• deps: update dependency cssnano to v6.0.2 (#44) (d2601cf)
• deps: update dependency feedparser to v6.0.11 (#48) (539cfe6)
• deps: update dependency langchain to ^0.0.353 (#49) (7a9987b)
• deps: update dependency rimraf to v5.0.5 (#45) (ee33868)
• replace tortoise-orm with peewee. No more async (af02a49)

v0.4.0 (2023-11-22)

👷 CI/CD

• bump Node from v16 to v18 (2c2b83e)
• remove requirements.txt because cloudflare recognizes poetry (c899203)

🚀 Features

• programmatically post to facebook (52567c7)

🐛 Bug Fixes

• ensure that file is closed (7837abd)

⚙️ Build System

• deps: add html5lib (54c6b3c)
• deps: fix psycopg dependencies to allow for better multiarch compatibility (f38ab3f)
• switch to node v18 (27a0249)
• update poetry to 1.6.1 (53d0ade)

♻️ Code Refactoring

• account for the situation where docker-compose doesn't exist (0712568)
• change social post prompt (1ff1aca)
• update Daily Mail article detail parser (33e330e)
• use html5lib instead of html.parser (50c2dfa)

v0.3.2 (2023-10-15)

🐛 Bug Fixes

• handle a situation where article div doesn't have expected class (8894eae)

📝 Docs

• minor documentation fixes (f58fd30)

⚙️ Build System

• deps: run poetry lock --no-update (0b16b3d)
• deps: update dependency langchain to v0.0.239 (#33) (7f21573)
• deps: update dependency ruff to v0.0.291 (#24) (1afb09f)
• deps: update node.js to v16.20.2 (#30) (809af83)

v0.3.1 (2023-07-16)

👷 CI/CD

• deps: update sosedoff/pgweb docker tag to v0.14.1 (1f5bd91)

🐛 Bug Fixes

• quick and dirty fix for exceeding token limit (94754b8)
• yet another hack to manage max token limit (28008a1)

v0.3.0 (2023-06-24)

💄 Styling

• let's use animate on scroll (494249d)

👷 CI/CD

• add environment variables for CI tests (00abab0)
• fix placement of env variables (6934d72)
• fix poetry setup (cdc7fb5)
• install poetry (bb0e2ba)
• use latest version of actions/checkout (d5aa008)

⚙️ Build System

• deps-dev: update dependency sass-loader to v13.3.2 (#25) (d160a24)
• deps: bump outdated python packages (79559cc)
• deps: remove animate.css (a042cce)
• deps: update dependency webpack-cli to v5.1.4 (#26) (9d32366)
• install mutagen (e83f772)
• install poetry and remove extraneous config files (b4ab738)
• replace isort and flake8 with ruff (31280f7)
• temporarily add requirements.txt to fix CF builds (80799c9)

✅ Tests

• add some sample test data to work with (8619606)
• add test for random_opening() (ee21e4c)
• fix coverage configuration (b06218d)
• fix test_update_article_with_summary_article_not_found (3c700b3)
• test transcript creation (a502554)
• write more tests (a5aed89)

🐛 Bug Fixes

• avoid returning multiple Article objects (26b60ea)
• correct metadata for episode 004 (af6dac4)
• datetime.datetime is the one with strptime method (f88063b)
• play/pause button controls & state on home page (8ca6d02)
• specify the correct(ish) episode pubDate (491248c)
• use mutagen to determine mp3 length (6ce9f19)
• use the correct syntax for rich text in episode description (4079a66)

♻️ Code Refactoring

• reduce the treble gain by half (from 6dB to 3dB) (c3c0f61)
• remove spacing on google/apple podcast button, and ad URLs (47e741d)
• use description instead of just specifying episode No. (cd04555)

🚀 Features

• add More ways to listen button and modal (239d429)
• change the voice sampling rate to 44.1kHz (110bd71)
• conditional rendering of (social) icons in footer (38fcbdc)
• separate modules for summarization backends (92c9af0)

v0.2.0 (2023-06-05)

🐛 Bug Fixes

• argument passed to random.choice for many articles (1720456)
• reduce treble gain from 10dB to 6dB (bc031f9)
• timeago implementation (a11d699)
• whitespace breaking accordion classes (2f48a5f)

💄 Styling

• fix broken stylelint config (4549c38)
• fix stylelint (73ccc23)

🚀 Features

• add RSS feed (26389ca)
• add social sharing buttons and fix some minor bugs (1b5cf8a)
• setup and configure 11ty web project (813e904)
• sound equalisation and album art for the audio file (8f41036)
• use aerich for database migrations (0306101)
• use apprise to send telegram notifications (fb2b123)
• use bootstrap 5.3, with built-in dark mode support (41c1181)
• use Jinja2 to render njk template for 11ty (d65e632)

✅ Tests

• write some tests (b50f5d8)

👷 CI/CD

• add cache-dependency-path on setup-python action (edba603)
• add Github Actions config (3a08a93)
• add test suite to CI/CD (1178143)
• fix coverage data upload (0877142)
• fix extraction of total coverage (312630f)
• fix python version (3acef2d)
• fix test job configuration (75c62d0)
• fix timezone setup in test job (1afd4be)
• generate coverage badge (a54be8f)
• install things as root (d95dc8e)
• no need to install unnecessary stuff (c561911)
• remove packages already installed (8b21a11)
• run prettier (1116575)
• run shellcheck on shell script(s) (58b2291)

⚙️ Build System

• add .nvmrc with node version set to 16 (cf208ac)
• add a bash script to be run by cron (901ca45)
• deps: add tortoise-orm and related packages (97ff236)
• deps: fix dependency conflicts & CI dependency installation (c16ad40)
• deps: install timeago.js (7c61700)
• deps: update dependency boto3 to v1.26.146 (#2) (adf0aa9)
• deps: update dependency botocore to v1.29.146 (#3) (fb4bb7e)
• deps: update dependency langchain to v0.0.189 (#5) (1b3108b)
• deps: update dependency typing-extensions to v4.6.3 (#7) (b916b65)
• deps: update python dependencies (05f6f24)
• deps: use psycopg2-binary due to failing cloudflare pages build (b5c4b34)
• images must be built in case there are significant changes (834636d)
• integrate healthchecks.io into the cron job (a69733e)
• specify python version to fix cloudflare pages build failure (f595b61)
• switch to ubuntu as base image (d07dd37)
• update Dockerfile (773694c)
• update ENV variables (3af2369)
• use docker for python developement (4cb7e4e)

♻️ Code Refactoring

• add aerich-related tasks and update paths (7764f68)
• add album art and reorganize images (abb52ab)
• add correct button depending on OS (2efdf69)
• add facebook icon and update dev link (2b18128)
• change code organisation (ad73f5b)
• finalise toolchain for the podcast audio production (9e08ebd)
• improve a number of litle things (a69ea21)
• improve code structure and some some abstractions (5102f9d)
• improve RSS feed data (f65d189)
• randomize some phrases (901b7f1)
• regenerate aerich database migrations (f2f1554)
• remove external playing for now. (fc4aa3d)
• update 11ty config to include RSS filter (018f1ea)
• update default date in models (e45ca83)
• update paths from src/... to app/... (174720a)
• update templates (3518d71)

📝 Docs

• add badges and TOC (78a7679)
• add some documentation and contribution guidelines (d713afa)
• update the docs by adding deployment guide (f468bec)

v0.1.0 (2023-05-26)

🐛 Bug Fixes

• use correct filepaths and squash a few other bugs (608c884)
• use correct path to content file, and decorate the toolchain fn with @task (2cc5ab1)

🚀 Features

• add script to fetch today's latest news from ZNBC (d25b56c)
• automate everything, no more manual processes (3b13230)
• play the audio file using VLC (68e119b)
• use boto3 SDK (5071ea0)
• use Invoke for task automation (257be9e)

♻️ Code Refactoring

• add more invoke tasks (43383ac)
• Ayanda is a much better host than Emma (1ee7b21)
• modify for use in epison 002 (6190d33)
• modify for use in epison 003 (4c24170)
• reorganize project files (52e1340)
• reorganize project files. This should have been part of 52e1340 (530dce5)
• use UA on requests job (1423323)

📝 Docs

• add more TODOs (e27d882)
• add notes (574d575)
• add README (bbeec27)
• add TODO items (64afb3c)
• update description in README (9c7ce19)
• yet another TODO (a6ce3a4)

⚙️ Build System

• deps: add more dependencies (0a11aa6)
• deps: install eyed3 and tiktoken (a7899a2)
• deps: use pyproject.toml to manage dependencies (3c98916)
• install commitizen (3db6785)
• use Node.js (88c7c82)