Skip to content

fqxp/nete-gtk

Repository files navigation

Build Status

DISCLAIMER: This is alpha state software. Expect bugs.

What is nete?

nete (pronounce: neat) will be a easy-to-use, useful note-taking application.

It's currently in pre-alpha state.

Plans

nete possibly will:

  • be easy to use
  • have a clean interface
  • never forget anything you typed
  • have multiple interfaces, like graphical, command line, or HTTP/AJAX
  • encrypt notes using GnuPG if desired
  • synchronize notes using an external tool like SyncThing, OwnCloud/Nextcloud or the like
  • and a few more

Installation

Assume $PROJECT_DIR is the directory you cloned this repository into.

Package dependencies

Debian buster

Install Debian packages:

$ sudo apt-get install python3 gir1.2-webkit2-4.0 \
  gir1.2-gtksource-4

ArchLinux

Install packages:

$ sudo pacman -S python webkit2gtk gtksourceview4

Install

Change into project directory and install using setuptools:

$ cd $PROJECT_DIR
$ ./setup.py install --user

You should now have the script nete-gtk in your path. Run it!

Development

Development Setup

First, set up a virtualenv to install required development packages into and install development requirements:

$ cd $PROJECT_DIR
$ virtualenv venv
$ source venv/bin/activate
(venv)$ python setup.py egg_info -b dev develop

You should now have the nete-gtk script installed in the virtual environment. The egg_info -b dev makes sure the development version of nete-gtk never communicates with your system-wide nete installation (see this Stackoverflow question)

Run the application:

(venv)$ nete-gtk

For the interesting debug info (including actions and state changes), run:

(venv)$ nete-gtk --debug

To additionally output tracebacks at action dispatch time, run:

(venv)$ nete-gtk --debug --traceback

Running tests

Run tests:

(venv)$ pytest

Create a binary distribution

Run:

$ ./setup.py bdist_egg

About

A note-taking tool in development

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages