{"id":15905720,"url":"https://github.com/skulltech/journalist","last_synced_at":"2025-03-21T01:31:53.205Z","repository":{"id":62572714,"uuid":"115550711","full_name":"skulltech/journalist","owner":"skulltech","description":"App to write journal digitally. Simple as that.","archived":false,"fork":false,"pushed_at":"2018-02-06T17:07:07.000Z","size":130,"stargazers_count":24,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-13T13:22:24.923Z","etag":null,"topics":["diary","flask","github-api","journal","markdown","markdown-to-html","markdown-viewer"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skulltech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-27T19:20:47.000Z","updated_at":"2024-08-14T19:50:24.000Z","dependencies_parsed_at":"2022-11-03T18:27:01.351Z","dependency_job_id":null,"html_url":"https://github.com/skulltech/journalist","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skulltech%2Fjournalist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skulltech%2Fjournalist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skulltech%2Fjournalist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skulltech%2Fjournalist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skulltech","download_url":"https://codeload.github.com/skulltech/journalist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244333025,"owners_count":20436123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diary","flask","github-api","journal","markdown","markdown-to-html","markdown-viewer"],"created_at":"2024-10-06T13:07:23.937Z","updated_at":"2025-03-21T01:31:52.891Z","avatar_url":"https://github.com/skulltech.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# journalist\nApp to write journal digitally. \n\n[![PyPI version](https://badge.fury.io/py/journalist.svg)](https://badge.fury.io/py/journalist)\n\n## Features\n\n- Write your journal using _Markdown_ in your favorite text-editor.\n- Stores written journals in a comprehensive directory structure.\n- View the journals (_Markdown_ rendered in _HTML_) in browser.\n\n# Installation\n\nInstall it using `pip`\n```console\n$ pip install journalist\n```\n\n# Usage \n\n```console\n$ python3 journalist.py -h\nusage: journalist.py [-h] {write,view} name\n\npositional arguments:\n  {write,view}  Task to do\n  name          The name of the journal\n\noptional arguments:\n  -h, --help    show this help message and exit\n```\n\n## Usage Examples\n\n### Writing journal\n\nJournals are stored in the directory `~/.journalist` in the following structure.\n\n```console\n$ tree .journalist \n.journalist\n└── journalname\n     └── YYYY\n        └── MM\n            └── YYYY-MM-DD-Day.md\n```\n\nFor example, an example `~/.Journalist` directory may contain\n```console\n$ tree .journalist \n.journalist\n├── personal\n│   ├── 2017\n│   │   └── 12\n│   │       └── 2017-12-28-Thu.md\n│   └── 2018\n│       └── 01\n└── technical\n    ├── 2017\n    │   └── 12\n    │       ├── 2017-12-28-Thu.md\n    │       └── 2017-12-29-Fri.md\n    └── 2018\n        └── 01\n            └── 2018-01-03-Wed.md\n\n10 directories, 4 files\n```\n\nTo write in a the journal _personal_, type in the following...\n```console\n$ python3 journalist.py write personal\n```\n\n- If any journal named _personal_ already exists, it will open up the relevant `.md` file corresponding to the system date (creating it if it doesn't exist).\n- If any journal named _personal_ doesn't exist, it will prompt the user if they want to create a new journal. If they agree, it will do so and open the corresponding `.md` file as described above.\n\nThe _markdown_ file will be opened in the editor mentioned in the `config.yaml` file (default is `nano`). If you change it to something else, make sure an file named `filename.md` can be opened using that editor by typing `editor filename.md` in the terminal.\n\n### Viewing journal\n\n```console\n$ python3 journalist.py view personal \n[*] Starting Journalist viewer webapp...\n[*] View this journal at http://127.0.0.1:5000/journalist?name=personal\n * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)\n```\n\nOpening the [URL](http://127.0.0.1:5000/journalist?name=personal) http://127.0.0.1:5000/journalist?name=personal in the browser would show us the journal entries rendered in HTML.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskulltech%2Fjournalist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskulltech%2Fjournalist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskulltech%2Fjournalist/lists"}