Metadata-Version: 2.1
Name: pynote
Version: 0.1.3
Summary: Note taking app.
Home-page: https://github.com/Euromance/pynote
Author: Euromance
Author-email: kysput@gmail.com
License: UNKNOWN
Project-URL: Repository, https://github.com/Euromance/pynote
Description: # Pynote
        
        [![codecov](https://codecov.io/gh/Euromance/pynote/branch/master/graph/badge.svg?token=aRfAPtBzsP)](https://codecov.io/gh/Euromance/pynote)
        
        Note taking app.
        Uses `NeoVim` and `bat` to edit and show notes respectively by default.
        Markdown is also enforced with default settings.
        
        Didn't see any point in not using `NeoVim` or `bat` since they are awesome
        and have syntax highlighting and line numbers and less/cat behaviour and stuff.
        Better than `print(file.read())` and `input()`, that's for sure!
        
        ## Installation
        
        ```
        pip install pynote
        ```
        
        ## Configuration
        
        Configuration is optional. The app will work with no config file at all
        or with some lines purged. It's okay as long as it's a valid TOML file.
        
        ```
        cp ./pynote.cfg.example ~/.pynote.cfg
        $EDITOR ~/.pynote.cfg
        ```
        
        ## Usage
        
        Notes will be saved to the directory you specified in config.
        Or `~/.notes` if you did not. Available commands:
        
        ```
        note edit sample-note
             # Create or edit a note with provided TITLE.
             # Launches `NeoVim` or the one you set in the config file.
        
        note list
             # Lists available notes.
        
        note view sample-note
             # View a note with provided TITLE.
             # Launches `bat` or the one you set in the config file.
        
        note delete sample-note
             # Deletes a note with provided TITLE.
             # Asks for confirmation as long as you don't pass `--force`!
        ```
        
        ## Development
        
        ```
        make deps
        make lint
        make testreport
        ```
        
        ## TODO
        
        - [x] Config
          - [x] Note directory
          - [x] Editor args
          - [x] Viewer args
          - [x] TOML config
        
        - [ ] Meta _(why tho)_
          - [ ] Categories
          - [ ] Creation date
          - [ ] SQLite or JSON????
        
        - [x] A sane Makefile _(without poetry bullshit)_
        - [x] Tests
        - [x] A sane README _(what's wrong with current iteration? mark as done.)_
        - [x] CI/CD
        - [x] Upload to PyPI
        
        - [ ] Super Fancy Stuff Probably Never To Be Implemented
          - [ ] Version control with Git or whatever or just plain diff patch
            - [ ] SQLite database to keep meta
            - [ ] Probably an actual Git repo lol what???
          - [ ] Synchronization
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.9,<4
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
