Skip to content

coskundeniz/eksisozluk

Repository files navigation

eksisozluk

A command line reader for https://eksisozluk.com/

Supported Functionalities

  • Read entries from titles of default channel(gundem)
  • Read entries from titles of other channels
  • Read entries of an author
  • Save selected titles as favourite
  • Get today's entries from favourite titles
  • Save selected entries as favourite
  • Show entries saved as favourite
  • Change console output theme

How to setup

If you will use MongoDB to save titles/entries, install it from here. Otherwise SQLite database will be used.

You can check the running status after installation and start the database server with the following commands on Linux.

  • sudo service mongod status
  • sudo service mongod start

Run one of the followings to install required packages

  • pipenv install && pipenv shell
  • pip install -r requirements.txt

How to create Docker image manually

Install docker from here and run the following commands in the project directory.

  • docker build -t eksisozluk .
  • docker volume create eksisozluk_db

How to use

usage: python eksisozluk.py [-h] [-ch] [-ae] [-ft] [-lfte] [-fe] [-lfe] [-th THEME]

optional arguments:
  -h, --help                 show this help message and exit
  -ch, --channels            Get titles from other channels
  -ae, --author_entries      Get author entries
  -ft, --favtitle            Add selected titles to favourites
  -lfte, --listfavtitleentry Get today's entries from favourite titles
  -fe, --faventry            Add selected entries to favourites
  -lfe, --listfaventry       Show entries saved as favourite
  -th THEME, --theme THEME   Change theme

How to run Docker image

If you created the image manually according to above commands, run the following command.

  • docker run --rm -it -v eksisozluk_db:/src eksisozluk

You can add options as normal.

  • docker run --rm -it -v eksisozluk_db:/src eksisozluk -ch -fe

If you want to use prebuilt image from DockerHub, you can use the following commands.

  • docker pull codenineeight/eksisozluk

  • docker run --rm -it -v eksisozluk_db:/src codenineeight/eksisozluk


Screenshots

Listing channels

Channels

Getting author entries

Author Entries

Show entries from a title

Show entries from a title

Save entry to favourites

Save entry

Show favourite entries

Show favourite entries

Save titles to favourites

Save title

Save duplicate title

Save duplicate title

Get entries from favourite titles

Get entries from favourite titles

Load more dialog for titles

Load more dialog for titles

Secondary theme with green variants

secondary theme 1

secondary theme 2

secondary theme 3

Invalid input errors

Invalid input errors

Invalid input errors