Skip to main content

A simple tool to add descriptions to directories by creating .lsnotes files, with endless possibilities for customization.

Project description

lsnotes

Adding descriptions to your directories!


What’s lsnotes?

lsnotes lets you attach and display notes for directories. Just drop a .lsnotes file in any folder and voilà—your directory has a description. Now remade with:

  • Python — easier to use and extend
  • Typer — for snappy, intuitive CLI
  • Markdown support — so your notes can look sleek and formatted

A story

It was originnaly just an April Fools joke that I told @MrWillCom, but it turned out to be a brilliant idea. So I made this project.

Installation

Clone and build by yourself!

poetry install

or get it from PyPI!

pip install lsnotes

Usage

lsnotes view # does the same as above

lsnotes --help # for assistance

lsnotes edit # edits the .lsnotes file with your default editor

lsnotes config # for configuration

Examples

alias ls = "lsnotes view && ls"
alias pwd = "lsnotes view && pwd"
# etc.

Other Ports

We welcome you to implement the .lsnotes standard using various languages or on diverse platforms.


Made with love by @aeilot at aeilot.top

Project details


Download files

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

Source Distribution

lsnotes-1.0.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lsnotes-1.0.0-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file lsnotes-1.0.0.tar.gz.

File metadata

  • Download URL: lsnotes-1.0.0.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.13 Darwin/21.6.0

File hashes

Hashes for lsnotes-1.0.0.tar.gz
Algorithm Hash digest
SHA256 eaed58841512f9738eb3160a196067e085484ee822993635faa75a8b0a9127fc
MD5 619147ec16f0ab54c42a2580c205894d
BLAKE2b-256 26183b041fcd607172b649d2570fb5fd5456a8915257e2b158a966ae1cfa6c09

See more details on using hashes here.

File details

Details for the file lsnotes-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: lsnotes-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.13 Darwin/21.6.0

File hashes

Hashes for lsnotes-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2213a9a52fd04fe192ca5b0689dbc0989b2eaa6a2de9297ebfc43b20a0f5d9cc
MD5 9286b26c472a9ad832b07c04ec863466
BLAKE2b-256 aaca0a3863e6c27b74039636f93b321b7bd333f6a38cc57922b9e4a877c3426e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page