Metadata-Version: 2.4
Name: lisq
Version: 2025.5.3
Summary: Single file note-taking app that works with .txt files
Home-page: https://github.com/funnut/Lisq
Author: funnut
Author-email: funnut <essdoem@yahoo.com>
License: # LICENSE
        
        ## Polska wersja
        
        **Copyright © funnut**
        
        Niniejszy kod może być kopiowany, modyfikowany i używany **tylko do celów niekomercyjnych**.
        
        ### Zabronione jest:
        - wykorzystywanie kodu w projektach komercyjnych (np. aplikacjach, usługach, produktach przynoszących dochód),
        - sprzedaż tego kodu lub jego fragmentów,
        - używanie w działaniach reklamowych lub marketingowych.
        
        ### Dozwolone jest:
        - użycie w projektach edukacyjnych, hobbystycznych i prywatnych,
        - dzielenie się kodem z innymi, pod warunkiem dołączenia tej licencji,
        - modyfikowanie kodu – ale tylko w celach niekomercyjnych.
        
        W przypadku wątpliwości lub chęci uzyskania licencji komercyjnej, skontaktuj się z autorem:  
        **funnut** ([https://github.com/funnut](https://github.com/funnut))
        
        **Wszelkie prawa zastrzeżone.**
        
        ---
        
        ## English version
        
        **Copyright © funnut**
        
        This code may be copied, modified, and used **for non-commercial purposes only**.
        
        ### It is forbidden to:
        - use the code in commercial projects (e.g. apps, services, products that generate income),
        - sell this code or any part of it,
        - use it in advertisements or marketing.
        
        ### It is allowed to:
        - use the code in educational, hobby, or personal projects,
        - share the code with others as long as this license is included,
        - modify the code – but only for non-commercial purposes.
        
        If in doubt or if you want a commercial license, contact the author:  
        **funnut** ([https://github.com/funnut](https://github.com/funnut))
        
        **All rights reserved.**
        
Project-URL: Bug Tracker, https://github.com/funnut/Lisq/issues
Project-URL: Source Code, https://github.com/funnut/Lisq
Classifier: Programming Language :: Python :: 3
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# Lisq

From Polish *"lisek / foxie"* – lisq is a [**single file**](https://github.com/funnut/Lisq/blob/main/lisq/lisq.py) note-taking app that work with `.txt` files.

![Zrzut ekranu](https://raw.githubusercontent.com/funnut/Lisq/refs/heads/main/screenshot.jpg)

*Code available under a non-commercial license (see LICENSE file).*

**Copyright © funnut**

## Instalation

```bash
pip install lisq
```

then type `lisq`

> How to install Python packages visit [this site.](https://packaging.python.org/en/latest/tutorials/installing-packages/)

---

### Important

+ Default path to your notes is `~/notes.txt`.
+ Default editor is `nano`.

To change it, set the following variables in your system by adding it to `~/.bashrc` or `~/.zshrc`.

```bash
export NOTES_PATH="/file/path/notes.txt"
export NOTES_EDITOR="nano"
```

## Commands

```bash
quit, q, exit   # Exit the app  
clear, c        # Clear the screen  

show, s         # Show recent notes (default 10)  
show [int]      # Show [integer] number of recent notes  
show [str]      # Show notes containing [string]  
show all        # Show all notes  
show random, r  # Show a random note  

del [str]       # Delete notes containing [string]  
del last, l     # Delete the last note  
del all         # Delete all notes  

reiterate       # Renumber notes' IDs  
path            # Show the path to the notes file  
edit            # Open the notes file in editor
```


## CLI Usage

```bash
lisq [command] [argument]
lisq / 'sample note text'
lisq add 'sample note text'
```
