Metadata-Version: 2.4
Name: nnote
Version: 0.3.5
Summary: A plain, file-based note-taking CLI
Keywords: notes,cli,note-taking,productivity
Author-email: Agil Mammadov <mammadovagil@proton.me>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-Expression: GPL-3.0-or-later
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Utilities
Classifier: Topic :: Text Editors
License-File: LICENSE
Requires-Dist: click>=8.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: pytest>=8.0 ; extra == "dev"
Requires-Dist: furo>=2024.0 ; extra == "docs"
Requires-Dist: sphinx>=7.0 ; extra == "docs"
Project-URL: Documentation, https://stiermid.github.io/nnote
Project-URL: Repository, https://github.com/stiermid/nnote
Provides-Extra: dev
Provides-Extra: docs

# nnote

![PyPI - Version](https://img.shields.io/pypi/v/nnote?logo=pypi&label=nnote)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nnote)
![PyPI - Downloads](https://img.shields.io/pypi/dm/nnote)
![Github commits (since latest release)](https://img.shields.io/github/commits-since/stiermid/nnote/latest.svg)

<a href="https://repology.org/project/nnote/related">
	<img src="https://repology.org/badge/vertical-allrepos/nnote.svg" alt="Packaging status" align="right">
</a>

A plain, file-based note-taking CLI.

## Installation

**Arch Linux (AUR)**

```bash
yay -S nnote
```

Or with any other AUR helper, or manually via `makepkg`.

**From source**

```bash
pip install -e .
```

## Setup

```bash
nnote init
```

Prompts for a notes directory (default: `~/nnotes`) and a default editor. Config is saved to `~/.config/nnote/config.yaml`. If `$EDITOR` is set in your environment, it will be used as the editor default.

## Documentation

Full documentation is published at [stiermid.github.io/nnote](https://stiermid.github.io/nnote/).

## License

This project is licensed under the GNU General Public License v3.0 or later. See [LICENSE](LICENSE) for details.

