Skip to main content

A personal note-taking engine.

Project description

Luculia

Commits Tracker Version PythonV License

Luculia is a personal note-taking engine, written in Python by Stephen Malone. Use it to create, edit and organise your text files, all from the command-line!

Installation

  1. Install Python and run pip install luculia.
  2. Run luculia init to run the interactive setup tool.

Alternately, you can download the latest source release and install it yourself.

Usage

Basic Concepts

Luculia expects to you have a bunch of text files using a single extension in a single directory. These files are always referenced by name, lowercase and without extension.

For example, if you have a directory like this:

- notes/
  - alpha.txt
  - bravo.txt
  - charlie.txt

You can manipulate them like this:

$ luculia list
alpha
bravo
charlie

$ luculia show charlie
Chaaaarliiiie!

$ luculia open delta
(this opens "notes/delta.txt" in your default editor)

Configuration Files

The default configuration file location is ~/.luculia (i.e.: a file named .luculia in your home directory). If you'd like to put your configuration file somewhere else, set the environment variable LUCULIA to the file's path.

Example configuration file.
# # # # # # # # # # # # # # # #
# Luculia Configuration File. #
# # # # # # # # # # # # # # # #

# The path to your notes directory.
directory = "~/notes"

# The extension your note files use.
extension = "txt"

Command Guide

list

List all existing notes in alphabetical order.

Example.
$ luculia list
alpha
bravo
charlie

Contribution

Please submit any bugs or proposals to the public issue tracker. Thank you!

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for luculia, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size luculia-0.1.0-py3-none-any.whl (9.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size luculia-0.1.0.tar.gz (7.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page