Metadata-Version: 2.1
Name: nncli
Version: 0.3.1
Summary: NextCloud Notes Command Line Interface
Home-page: https://github.com/djmoch/nncli
License: UNKNOWN
Author: Daniel Moch
Author-email: daniel@danielmoch.com
Requires-Python: >=3
Description-Content-Type: text/x-rst
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console :: Curses
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: urwid
Requires-Dist: requests
Requires-Dist: appdirs
Requires-Dist: click
Requires-Dist: pipenv; extra == "dev"
Requires-Dist: sphinx; extra == "doc"
Project-URL: Documentation, https://nncli.readthedocs.io/en/latest
Provides-Extra: dev
Provides-Extra: doc

nncli is a Python application that gives you access to your NextCloud
Notes account via the command line. It's a "hard" fork of
sncli_. You can access your notes via
a customizable console GUI that implements vi-like keybinds or via a
simple command line interface that you can script.

Notes can be viewed/created/edited in *both an* **online** *and*
**offline** *mode*. All changes are saved to a local cache on disk and
automatically sync'ed when nncli is brought online.

More detailed documentation can be found in the docs.

Requirements
------------

- `Python 3`_

- Urwid_ Python 3 module

- Requests_ Python 3 module

- A love for the command line!

Installation
------------

- Via pip (latest release):

  - ``pip3 install nncli``

- Manually:

  - If you don't already have it, install Flit_: ``pip3 install flit``

  - Clone this repository to your hard disk: ``git clone
    https://github.com/djmoch/nncli.git``

  - Install nncli: ``flit install --deps production``

- Development:

  - Clone the repo

  - Install Pipenv: ``pip3 install pipenv``

  - Stand up development virtualenv: ``pipenv install --dev``

Features
--------

- Console GUI

  - full two-way sync with NextCloud Notes performed dynamically in the
    background

  - all actions logged and easily reviewed

  - list note titles (configurable format w/ title, date, flags, category,
    keys, etc)

  - sort notes by date, alpha by title, category, favorite on top

  - search for notes using a Google style search pattern or Regular
    Expression

  - view note contents and meta data

  - pipe note contents to external command

  - create and edit notes (using your editor)

  - edit note category

  - delete notes

  - favorite/unfavorite notes

  - vi-like keybinds (fully configurable)

  - Colors! (fully configurable)

- Command Line (scripting)

  - force a full two-way sync with NextCloud Notes

  - all actions logged and easily reviewed

  - list note titles and keys

  - search for notes using a Google style search pattern or Regular
    Expression

  - dump note contents

  - create a new note (via stdin or editor)

  - import a note with raw json data (stdin or editor)

  - edit a note (via editor)

  - delete a note

  - favorite/unfavorite a note

  - view and edit note category

Acknowledgements
----------------

nncli is a fork of sncli_ by Eric Davis. This application further pulls in
and uses modified versions of the simplenote.py_ module by Daniel Schauenberg and
the notes_db.py module from nvpy_ by Charl P. Botha.

.. _sncli: https://github.com/insanum/sncli
.. _Python 3: http://python.org
.. _Urwid: http://urwid.org
.. _Requests: https://requests.readthedocs.org/en/master
.. _simplenote.py: https://github.com/mrtazz/simplenote.py
.. _nvpy: https://github.com/cpbotha/nvpy
.. _Flit: https://flit.readthedocs.io

