Metadata-Version: 2.4
Name: journal-manager
Version: 1.2
Author-email: Daniel Martins Antunes <danoan2008@gmail.com>
License: MIT License
        
        Copyright (c) 2022-present Daniel Martins Antunes <danoan2008@gmail.com>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Documentation, https://github.com/danoan/journal-manager#readme
Project-URL: Issues, https://github.com/danoan/journal-manager/issues
Project-URL: Source, https://github.com/danoan/journal-manager
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: dataclasses
Requires-Dist: jinja2
Requires-Dist: toml
Requires-Dist: typing_extensions
Requires-Dist: mkdocs
Requires-Dist: mkdocs-material
Requires-Dist: importlib_resources
Requires-Dist: quick-notes
Requires-Dist: toml_dataclass
Dynamic: license-file

# Getting started with journal-manager

Organize your MkDocs journals with ease, fostering focused learning one topic at a time.
[Read the docs](https://danoan.github.io/journal-manager/).

## What is journal-manager?

*journal-manager* is a command-line interface (CLI) application designed for the
organization of MkDocs notebooks and journals. *journal-manager* facilitates 
the prioritization of learning, one topic and one journal at time.

The terminal interface in combination with markdown text reduces distraction and 
improves productivity. *journal-manager* will be a valuable companion on your 
learning quest.

## Installation

```bash
$ git clone https://github.com/danoan/journal-manager
$ cd journal-manager
$ pip install .
```

## Setup

```bash
# Setup environment variable (e.g. in ~/.bashrc)
export JOURNAL_MANAGER_CONFIG_FOLDER="~/.config/journal-manager" 
```

```python
$ jm setup init
$ Enter the path of your default editor: nvim

default_journal_folder=/home/my-user/.config/journal-manager/journals
default_template_folder=/home/my-user/.config/journal-manager/templates
journal_data_filepath=/home/my-user/.config/journal-manager/journal_data.toml
template_data_filepath=/home/my-user/.config/journal-manager/template_data.toml

default_text_editor_path=nvim
```

## Usage

### Create and edit journals

```bash
$ jm journal create "nlp" 
$ jm journal
nlp:/home/my-user/.config/journal-manager/journals/nlp
$ jm journal edit nlp
```

### Create journal-manager template

```bash
$ jm template register "with-latex" "~/my-journal-manager-templates/with-latex"
$ jm template 
with-latex:/home/my-user/.config/journal-manager/templates/with-latex
$ jm journal create "statistics" --template-name "with-latex"
$ jm journal
nlp:/home/my-user/.config/journal-manager/journals/nlp
statistics:/home/my-user/.config/journal-manager/journals/statistics
```

### Build static web page

```bash
$ jm build --build-location "~/my-journal-web-page"
```




