Metadata-Version: 2.5
Name: mlog
Version: 0.2.0
Summary: A command-line personal log
Project-URL: Homepage, https://codeberg.org/anglyan/mlog
Project-URL: Repository, https://codeberg.org/anglyan/mlog
Author-email: anglyan <angel.yanguas@gmail.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Keywords: cli,journal,log,logbook
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Description-Content-Type: text/markdown

# mlog

A command-line personal log.

`mlog` is an easy to use command-line personal log. It comprises two
command-line applications:

- `mlog` — add new entries to the logbook
- `mlogbook` — retrieve entries from the logbook

Entries are stored as a simple CSV file under `~/.mlog/logbook.csv`.

Run either command with `-h` for the full list of options.

## Installation

```bash
pip install mlog
```

Or, from a checkout of this repository:

```bash
pip install .
```

## Examples

- Logging an entry:

  ```bash
  mlog This is a new entry
  ```

- Logging an entry assigned to a *project*:

  ```bash
  mlog -p myproject This is a new entry
  ```

- Listing all the entries in the logbook:

  ```bash
  mlogbook list
  ```

- Listing all the projects in the logbook:

  ```bash
  mlogbook projects
  ```

- Listing all the entries belonging to a given project:

  ```bash
  mlogbook list -p myproject
  ```

- Listing all the entries logged from a given date:

  ```bash
  mlogbook list -f 2012/12/31
  ```

- Listing all the entries up to a given date:

  ```bash
  mlogbook list -t 2012/12/31
  ```

- Finding all the entries matching a given string:

  ```bash
  mlogbook search mystring
  ```

- Finding all the entries from a project matching a given string:

  ```bash
  mlogbook search -p myproject mystring
  ```

## License

GPL-3.0-or-later. See [LICENSE](LICENSE).
