https://github.com/jarvis394/notty

📝⚡ Fast terminal-based notes application
https://github.com/jarvis394/notty

Last synced: 19 days ago
JSON representation

📝⚡ Fast terminal-based notes application

• Host: GitHub
• URL: https://github.com/jarvis394/notty
• Owner: jarvis394
• Created: 2020-02-14T13:02:00.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-28T06:40:43.000Z (almost 5 years ago)
• Last Synced: 2024-11-07T11:49:42.527Z (2 months ago)
• Language: Python
• Size: 244 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


notty

📝⚡ Fast terminal-based notes application


## Setup

Installation via `pip`:

```bash

$ pip install notty

```

Updating:

```bash

$ pip install notty --upgrade

```

Executing:

```bash

$ notty

Usage: notty [OPTIONS] COMMAND [ARGS]...

```

**If you're using Anaconda:**

1. Create new virtual environment

    ```bash

    (base) $ conda create -n YOURNAME python=3

    Collecting package metadata (current_repodata.json): done

    Solving environment: done

    ... # hit [y] for the packages' installation

    ```

2. Activate newly created environment

    ```bash

    (base) $ conda activate YOURNAME

    (YOURNAME) $

    ```

3. Install via `pip`:

    ```bash

    (YOURNAME) $ pip install notty --upgrade

    ```

4. To return to the `(base)` environment, run `conda deactivate`:

    ```bash

    (YOURNAME) $ conda deactivate

    (base) $ 

    ```

*Currently built for **Python 3.x***

## Usage

For more information, run `notty --help`

|Command|Aliases|Description|

|-|-|-|

|create|*c, create*|Creates a new note|

|list|*l, list*|Lists all notes.
Actually, it can create, delete, rename the notes, so it might be the most important thing here|

|edit ``|*e, edit*|Edits the note with a given ID (opens up a default editor)|

## Contribution

...is welcomed. PR's are widely opened.

## Contact

Me: [VK](https://vk.com/tarnatovski)