clearly documented API
minimal web interface
Development should follow a problem-solution approach.
In no particular order:
reader uses the Black style.
You should enforce it by using pre-commit. To install it into your git hooks, run:
pip install pre-commit # ./run.sh install-dev already does both pre-commit install
Every time you clone the repo, running
pre-commit install should always be
the first thing you do.
First, install the testing dependencies:
./run.sh install-dev # or pip install '.[cli,app,tests,dev,unstable-plugins]'
Run tests using the current Python interpreter:
Run tests using the current Python interpreter, but skip slow tests:
Run tests for all supported Python versions:
Run tests with coverage and generate an HTML report (in
Run the type checker:
./run.sh typing # or mypy --strict src
Start a local development server for the web application:
./run.sh serve-dev # or FLASK_DEBUG=1 FLASK_TRAP_BAD_REQUEST_ERRORS=1 \ FLASK_APP=src/reader/_app/wsgi.py \ READER_DB=db.sqlite flask run -h 0.0.0.0 -p 8000
Building the documentation¶
First, install the dependencie:
pip install '.[docs]' # ./run.sh install-dev already does it for you
The documentation is built with Sphinx:
./run.sh docs # or make -C docs html # using Sphinx's Makefile directly
The built HTML docs should be in
Making a release¶
Making a release (from
x + 1):
scripts/release.py already does most of these.
(release.py) bump version in
(release.py) update changelog with release version and date
(release.py) make sure tests pass / docs build
(release.py) clean up dist/:
rm -rf dist/
(release.py) build tarball and wheel:
python -m build
(release.py) push to GitHub
(release.py prompts) wait for GitHub Actions / Codecov / Read the Docs builds to pass
upload to test PyPI and check:
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
(release.py) upload to PyPI:
twine upload dist/*
(release.py) tag current commit with <major>.<minor> and <major>.x (e.g. when releasing 1.20: 1.20 and 1.x)
(release.py prompts) create release in GitHub
build docs from latest and enable
ydocs version (should happen automatically after the first time)
(release.py) bump versions from
(y + 1).dev0, add
(y + 1)changelog section
(release.py prompts) trigger Read the Docs build for <major>.x (doesn’t happen automatically)
Folowing are various design notes that aren’t captured somewhere else (either in the code, or in the issue where a feature was initially developed).
Why use SQLite and not SQLAlchemy?¶
tl;dr: For “historical reasons”.
In the beginning:
I think by that time I was already a great SQLite fan, and knew that because of the relatively single-user nature of the thing I won’t have to change databases because of concurrency issues.
The fact that I didn’t know exactly where and how I would deploy the web app (and that SQLite is in stdlib) kinda cemented that assumption.
Since then, I did come up with some of my own complexity: there’s a SQL query builder, a schema migration system, and there were some concurrency issues. SQLAlchemy would have likely helped with the first two, but not with the last one (not without dropping SQLite).
Note that it is possible to use a different storage implementation; all storage stuff happens through a DAO-style interface, and SQLAlchemy was the main real alternative I had in mind. The API is private at the moment (1.10), but if anyone wants to use it I can make it public.
It is unlikely I’ll write a SQLAlchemy storage myself, since I don’t need it (yet), and I think testing it with multiple databases would take quite some time.
Multiple storage implementations¶
Detailed requirements and API discussion: #168#issuecomment-642002049.
file:// handling, feed root, per-URL-prefix parsers (later retrievers, see below):
detailed requirements: #155#issuecomment-672324186
Requests session plugins:
Retriever / parser split:
Survey of possible options: #123#issuecomment-582307504.
In 2021, I’ve written an entire series about it: https://death.andgravity.com/query-builder
Pagination for methods that return iterators¶
Why do it for the private implementation: #167#issuecomment-626753299 (also a comment in storage code).
Detailed requirements and API discussion for public pagination: #196#issuecomment-706038363.
From the initial issue:
detailed requirements and API discussion: #122#issuecomment-591302580
discussion of possible backend-independent search queries: #122#issuecomment-508938311
Enabling search by default, and alternative search APIs: #252.
Change feed URL¶
From the initial issue:
Entry user data¶
#228#issuecomment-810098748 discusses three different kinds, how they would be implemented, and why I want more use-cases before implementing them (basically, YAGNI):
entry searchable text fields (for notes etc.)
entry tags (similar to feed tags, may be used as additional bool flags)
entry metadata (similar to feed metadata)
also discusses how to build an enclosure cache/preloader (doesn’t need special reader features besides what’s available in 1.16)
#253 discusses using entry tags to implement the current entry flags (read, important); tl;dr: it’s not worth adding entry tags just for this.
As of late 2021, I closed #228 with wontfix, since I don’t have a use case for it, nor enough bandwidth to implement it.
Some thoughts about adding a
map argument: #152#issuecomment-606636200.
update_feeds() is like a pipeline: comment.
Data flow diagram for the update process, as of v1.13: #204#issuecomment-779709824.
return type: #204#issuecomment-780553373
Updating entries based on a hash of their content (regardless of
ideas for how to deal with spurious hash changes: #225
Decision to ignore feed.updated when updating feeds: #231.
Some initial thoughts on batch get methods (including API/typing) in #191 (closed with wontfix, for now).
Why I want to postpone batch update/set methods: #187#issuecomment-700740251.
tl:dr: Performance is likely a non-issue with SQLite, convenience can be added on top as a plugin.
Using a single Reader objects from multiple threads¶
Some thoughts on why it’s difficult to do: #206#issuecomment-751383418.
List of potential hooks (from mid-2018): #80.
Minimal plugin API (from 2021) – case study and built-in plugin naming scheme: #229#issuecomment-803870781.
We’ll add / document new (public) hooks as needed.
Requirements, thoughts about the naming scheme and prefixes unlikely to collide with user names: #186 (multiple comments).
Wrapping underlying storage exceptions¶
Which exception to wrap, and which not: #21#issuecomment-365442439.
Aware vs. naive, and what’s needed to go fully aware: #233#issuecomment-881618002.
Using MinHash to speed up similarity checks (maybe): https://gist.github.com/lemon24/b9af5ade919713406bda9603847d32e5