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.

v2.0.0 (2025-03-15)

⚠ BREAKING CHANGES

• Rewrite using JavaScript, with a primary focus on implementing a simple web app with a good UI/UX

🚀 Features

• complete rewrite of the application (055c311)

👷 CI/CD

• update softprops/action-gh-release action to v2 (#419) (188b6d1)

v1.1.0 (2025-03-15)

🚀 Features

• upgrade to flask v2 and update several outdated dependencies (f7a7aff)

♻️ Code Refactoring

• datetime.utcnow() is deprecated (0d6d498)
• fix port number (b306b9f)
• fix some broken things (f2eda19)
• make things work with Flask v2 (18eddc3)

👷 CI/CD

• fix config (cf564c6)
• make test job depend on lint job (8104407)
• more fixes (8c9de05)
• no need to install grunt-cli (e71644b)
• npm install -g grunt-cli (c7ac2d3)
• run tests in a container (202e2d4)
• switch to Github Actions (8917dec)
• update how environment variables are set (2e3847e)

🐛 Bug Fixes

• issue with python 3.12 and distutils (08bc941)

⚙️ Build System

• add honcho & bump isort and flake8 (dddce6f)
• deps-dev: update dependency black to v24.10.0 (#401) (8949ff1)
• deps-dev: update dependency bpython to v0.24 (6f2fdc8)
• deps-dev: update dependency commitizen to v3.29.1 (6ff9481)
• deps-dev: update dependency commitizen to v3.31.0 (#402) (d129873)
• deps-dev: update dependency faker to v8.16.0 (174a045)
• deps-dev: update dependency gtts to v2.5.3 (2d27fba)
• deps-dev: update dependency gtts to v2.5.4 (#399) (3fb7543)
• deps-dev: update dependency pre-commit to v2.21.0 (c15e451)
• deps-dev: update dependency pyupgrade to v3.19.0 (#403) (414c794)
• deps-dev: update dependency ruff to v0.6.4 (87d5efa)
• deps-dev: update dependency ruff to v0.6.6 (28d7512)
• deps-dev: update dependency ruff to v0.6.8 (871c879)
• deps-dev: update dependency ruff to v0.7.4 (#404) (30e7cd7)
• deps-dev: update dependency ruff to v0.8.2 (#410) (5db7cec)
• deps-dev: update dependency ruff to v0.8.3 (#412) (19e4945)
• deps-dev: update dependency sentry-sdk to v2.14.0 (873f276)
• deps-dev: update dependency sentry-sdk to v2.18.0 (#405) (40c4de2)
• deps-dev: update dependency sentry-sdk to v2.19.2 (#411) (26f8f65)
• deps-dev: update dependency setuptools to v74.1.2 (8edaeca)
• deps-dev: update dependency setuptools to v74.1.3 (6499b5d)
• deps-dev: update dependency tomli to v2.1.0 (#406) (af9ccc3)
• deps-dev: update dependency tomli to v2.2.1 (#413) (d697873)
• deps-dev: update dependency tqdm to v4.67.0 (#407) (4f95a6e)
• deps-dev: update dependency tqdm to v4.67.1 (#409) (589f9e1)
• deps: update dependency colorama to v0.4.6 (656198d)
• deps: update dependency eyed3 to v0.9.7 (b299353)
• deps: update dependency flask-debugtoolbar to v0.16.0 (#400) (084e21e)
• deps: update dependency flask-httpauth to v4.8.0 (778d284)
• deps: update dependency flask-mail to v0.10.0 (fdf1b5c)
• deps: update dependency flask-moment to v1.0.6 (8c5ea96)
• deps: update dependency flask-restful to v0.3.10 (1dfe973)
• deps: update dependency flask-talisman to v1.1.0 (4f3bf9a)
• deps: update dependency pytest-flask to v1.3.0 (de83cdb)
• deps: update dependency python-dotenv to v0.21.1 (84c566d)
• flask-script isn't used (54d7b1d)
• improve docker setup (7c10ce1)
• specify Node version (c68a1b6)
• switch to Node.js 16 (cb1e892)
• switch to poetry (88ab13f)
• we don't need libpq-dev (29fd5df)

v1.0.1 (2022-09-30)

🚀 Features

• set up HTTP security headers (2652a91)

🐛 Bug Fixes

• add missing kwarg content_security_policy in Talisman init_app (432cbdf)
• broken HTTP security headers configuration (be42945)
• change permission_policy to permissions_policy in flask-talisman config (f6d363b)
• cleanup Content Security Policy config (18ef459)
• rewrite autoplay permissions_policy (82bea8b)

📝 Docs

• add TODO item concerning CDN setup for mp3 files (5fa653e)

v1.0.0 (2022-09-30)

⚠ BREAKING CHANGES

• For the web app, it is now recommended to have files in the cloud, instead of locally

🚀 Features

• install gunicorn & add production deployment config for Dokku (6287f8f)
• remove metadata fetching using ffprobe (85016e6)
• store the mp3 files in the cloud and use ffprobe to get metadata (d475e87)

✅ Tests

• fix broken webapp test (acc1f58)

♻️ Code Refactoring

• do not load .prod.env in production (f493a0d)

👷 CI/CD

• add TENLISTS_MP3_CLOUD_STORAGE_BASE_URL environment variable to test job (78c3f3f)
• fix broken github actions test job (ccac365)
• fix broken test (f2f2f76)
• fix typo in circleci workflow (ba604d5)

📝 Docs

• update README with info on mp3 files & cloud storage (6461716)

⚙️ Build System

• deps-dev: install bpython (e502fce)
• deps: install ffmpeg (48cf8ae)
• docker: ensure that node_modules/.bin is in PATH (35e163d)
• docker: fix Dockerfile (a69937b), closes /github.com/dokku/dokku/issues/2742#issuecomment-351405317
• RUN npm install -g grunt-cli (5c2a08b)
• update .dockerignore file (181d0a4)
• use npm run build instead of calling individual Grunt tasks (4f5efc6)

v0.6.3 (2022-09-27)

🐛 Bug Fixes

• add configuration for npm as well (84e25c3)
• Name doesn’t conform to conventions (dfa7300)
• One-line docstring should fit on one line with quotes (de92f8d)
• put correct labels (7d3c3fb)
• remove non-existent reference to favicon.png in template (bc81283)
• requirements.txt to reduce vulnerabilities (e9ed814)
• requirements.txt to reduce vulnerabilities (c0a6730)
• requirements.txt to reduce vulnerabilities (d7d8f56)
• requirements.txt to reduce vulnerabilities (b1bfdf0)
• requirements.txt to reduce vulnerabilities (0cef07a)
• requirements.txt to reduce vulnerabilities (e5dd48e)

♻️ Code Refactoring

• avoid too many return statements within function (678a233)
• move env variables to repository root (b3beab3)
• only initialize debugtoolbar if app.debug is True (c247c3d)
• package.json: refactor to suit current setup (3155340)
• rearrange the project structure (ba01c1c)
• reduce cognitive complexity (ed7621a)
• remove else after try..except (e53cb61)
• rename project to ten-lists (#104) (579f6c6)
• update references to env variables in config (5693c14)
• webapp: refactor code and write simple test using pytest-flask (00cae26)

💄 Styling

• run black, isort and flake8 on entire codebase (0c1d8d1)

⚙️ Build System

• deps-dev: [Snyk] Security upgrade py from 1.9.0 to 1.10.0 (d1e39c0), closes #138
• deps-dev: add isort (26a7df0)
• deps-dev: bump black from 21.7b0 to 21.12b0 (6465b27)
• deps-dev: bump black to 21.7b0 (fcf9240)
• deps-dev: bump clean-css from 5.1.2 to 5.1.3 (#269) (2981d45)
• deps-dev: bump faker from 8.8.2 to 8.10.0 (#274) (28d843f)
• deps-dev: bump grunt from 1.2.1 to 1.3.0 (f2504f1)
• deps-dev: bump grunt from 1.2.1 to 1.3.0 (855b8d2)
• deps-dev: bump grunt-contrib-cssmin from 3.0.0 to 4.0.0 (820757f)
• deps-dev: bump gtts from 2.2.2 to 2.2.3 (#264) (0a74da8)
• deps-dev: fix vulnerabilities using npm audit fix (5031d6e)
• deps-dev: install invoke and commitizen (1396874)
• deps-dev: npm install cross-env -D (a62e021)
• deps-dev: update dependency clean-css to v5.1.5 (#310) (a54030c)
• deps-dev: update dependency doc8 to v0.9.0 (7ea2d2d)
• deps-dev: update dependency faker to v8.10.1 (c1c6d0a)
• deps-dev: update dependency faker to v8.10.2 (a89e7c2)
• deps-dev: update dependency faker to v8.10.3 (f909040)
• deps-dev: update dependency faker to v8.11.0 (fe35420)
• deps-dev: update dependency gtts to v2.2.3 (7633536)
• deps-dev: update dependency pre-commit to v2.14.0 (e91927f)
• deps-dev: update dependency sentry-sdk to v1.3.0 (87ee9e7)
• deps-dev: update dependency sentry-sdk to v1.3.1 (ba5c11a)
• deps-dev: update dependency tqdm to v4.61.2 (d8bef01)
• deps-dev: update dependency tqdm to v4.62.0 (f56cf5b)
• deps: bump autopep8 from 1.5.4 to 1.5.5 (b82c134)
• deps: bump autopep8 from 1.5.5 to 1.5.7 (feda8e1)
• deps: bump black from 20.8b1 to 21.5b1 (05881db)
• deps: bump black from 21.5b1 to 21.5b2 (1b942a8)
• deps: bump black from 21.5b2 to 21.6b0 (#258) (e478763)
• deps: bump bootstrap from 4.3.1 to 4.6.0 (#228) (86cad0b)
• deps: bump bpython from 0.20.1 to 0.21 (561f34f)
• deps: bump faker from 5.4.0 to 5.5.0 (32dd750)
• deps: bump faker from 5.5.0 to 5.5.1 (2420048)
• deps: bump faker from 5.5.1 to 5.6.0 (003afeb)
• deps: bump faker from 5.6.0 to 5.6.1 (d775658)
• deps: bump faker from 5.6.1 to 5.6.3 (69ebd9b)
• deps: bump faker from 5.6.3 to 5.6.5 (25a8ef5)
• deps: bump faker from 5.6.5 to 5.7.0 (b84ded5)
• deps: bump faker from 5.7.0 to 5.8.0 (20913e7)
• deps: bump faker from 8.1.3 to 8.2.0 (bf161f0)
• deps: bump faker from 8.8.0 to 8.8.2 (#268) (7d755de)
• deps: bump flask-httpauth from 4.2.0 to 4.3.0 (f1b10e4)
• deps: bump flask-httpauth from 4.3.0 to 4.4.0 (d889cbd)
• deps: bump holderjs from 2.9.7 to 2.9.9 (416b735)
• deps: bump jquery from 3.5.1 to 3.6.0 (#226) (566059c)
• deps: bump pip-chill from 1.0.0 to 1.0.1 (39289e2)
• deps: bump pip-tools from 6.1.0 to 6.2.0 (#266) (681cbf5)
• deps: bump pre-commit from 2.9.3 to 2.10.0 (c9e0819)
• deps: bump pytest-cov from 2.10.1 to 2.11.0 (1811a7a)
• deps: bump pytest-cov from 2.11.0 to 2.11.1 (9db260d)
• deps: bump pytest-cov from 2.11.1 to 2.12.0 (84a2cfb)
• deps: bump python packages (1c04f88)
• deps: bump python-dotenv from 0.15.0 to 0.17.1 (06770e3)
• deps: bump python-dotenv from 0.17.1 to 0.18.0 (#265) (db2a8a5)
• deps: bump sentry-sdk[flask] from 0.19.5 to 1.1.0 (85df934)
• deps: bump sentry-sdk[flask] from 0.19.5 to 1.1.0 (9e645a4)
• deps: bump sentry-sdk[flask] from 1.1.0 to 1.3.0 (#275) (147235f)
• deps: bump some outdated python dependencies (c60e8fa)
• deps: bump tqdm from 4.55.1 to 4.56.0 (fe50556)
• deps: bump tqdm from 4.61.1 to 4.61.2 (#273) (e6f34df)
• deps: pin markupsafe==2.0.1 (ec6d15e)
• deps: update dependency flask to v1.1.4 (f90ea2f)
• deps: update dependency flask-moment to v1.0.2 (1a4076a)
• deps: update dependency python-dotenv to v0.18.0 (46ba511)
• deps: update dependency python-dotenv to v0.19.0 (89c923a)
• deps: update Node.js dependencies (2a9c2e7)
• dockerize project (752fe86)
• install & configure standard-version, commitizen, cz-conventional-changelog (630bb7a)
• refactor Gruntfile to suit updated setup (51db7b9)
• streamline dependencies using pip-chill (de84186)
• update Gruntfile Browsersync task and run prettier (d811de6)

👷 CI/CD

• add Codacy Coverage Reporter (94e6de5)
• add codeclimate configuration (e4eb74d)
• add dependencies label to pin update type (4a3a173)
• add docker to renovate configuration (1dc40ac)
• add GitHub Actions release job (ebfdf93)
• add linting tasks (#287) (345dfe3)
• add renovate.json (#276) (ddddb13)
• automerge pin update types (6fcee42)
• configure renovate (4e34ff1)
• deps: update precommit hook pre-commit/pre-commit-hooks to v3.4.0 (f57279c)
• deps: update precommit hook pre-commit/pre-commit-hooks to v4 (#301) (7d1d0a3)
• deps: update precommit hook pycqa/flake8 to v3.9.2 (0812664)
• fix renovate config (#285) (e9dedcb)
• fix renovate config (#285) (992cd16)
• fix typo (pyest --> pytest) (6699ff6)
• initial setup of env variables for tests (aec6ec1)
• install global npm packages as root (2282eff)
• remove dependabot.yml configuration file (f5dee2d)
• switch from circleci/python:3.7 to cimg/python:3.8-node (4dbf8d7)
• update circleCI config (76ae8d7)
• update greeting message for issue submission (bea69e6)

✅ Tests

• add dirs_exist_ok=True to copytree command (90fe44d)
• update coverage configuration (a1bf839)
• write more tests for the webapp (#286) (31ce52d)

📝 Docs

• cleanup changelog in preparation for conventional changelog (9238cb0)
• hardcode issue URL (7a57f87)
• README: update the docs (8c0a4ea)
• update README (427cbca)
• update README TOC and remove requires.io badge (a178b3e)

v0.6.2 (2020-01-29)

Added

• Windows Support

v0.6.1 (2019-09-29)

Added

• the script now has tests! I'll still add some more tests

v0.6.0 (2019-09-28)

Changed

• the structure of the code to make it easier to read and test. Far from perfect -- more work still needs to be done.
• switched from argparse to Click for the CLI
• the BIBLE_DIRECTORY can now be specified through the CLI as an argument, but a default one is provided

Added

• some fancy terminal enhancements courtesy of colorama, termcolor and pyfiglet

v0.5.0 (2019-06-22)

Changed

• the codebase from python2 to python3.

v0.4.0 (2015-05-11)

Added

• the ability to change ID3 tag info in the copied files, so that whenever you play the files from any device (eg car, home theatre), the desired order is maintained.
• the ability to rename the files so that their sequence follows the desired reading plan order, instead of the order of appearance in the Bible. Key Modules: eyed3, os.rename

Changed

• the naming convention of files and directories by enforcing a 3-digit number by padding with zeroes using the zfill() function. This was done because I noticed that when I was creating a one week playlist from day 96 to 102; day100 was considered as occuring before day96 during processing, which isn't the case. This is because of the 1 after the day. Thus, to fix the problem, we need to have day096 instead of day96.

NOTE: I don't know what happened for v0.3.0 to be skipped! Anyway, these were my early dev days!

v0.2.0 (2014-05-27)

Added

• the ability to copy (using shutil) the files on the playlist file into a new folder so that you can carry the folder and listen anywhere (car, home theatre, etc).

v0.1.0 (2014-05-27)

• Initial version