# Feeling
## Introduction
Feeling is designed to be a simple terminal-based feelings tracker,
providing a simple command line interface for recording a feeling at any
time, and an application (built with
[Textual](https://textual.textualize.io/) for reviewing the recorded
feelings.
## Installation
Feeling can be installed using [`pipx`](https://pypa.github.io/pipx/):
```sh
$ pipx install feeling-cli
```
**NOTE:** The package name (`feeling-cli`) is slightly different from the
actual application name because the package name wasn't available via PyPi.
## Usage
Feeling is one command that is split into two parts. There is a simple
command line interface for recording a feeling, and a full-screen user
interface for looking back over what's been recorded and how it all fits
together and flows.
### Recording a feeling
To record a feeling, on the command line, just type:
```sh
$ feeling <rating> <description>
```
So, for example:
```sh
$ feeling good I installed feeling and will use it to track how I feel
```
This will make a record for the moment that the feeling is recorded. You can
do this as many times as you like. The more you record, the more you'll
build up a record of your day, month, year...
Feeling takes a simple approach of having five levels of feeling, and it
will also look for various words that map to those levels (I'll add to them
over time). The levels and the words associated with them are:
### -2
Very low. Words associated with this level are:
- Horrible
- Lowest
- Rubbish
- Worst
### -1
Low. Words associated with this level are:
- Blah
- Down
- Downbeat
- Low
- Meh
- Negative
### 0
Neutral. Words associated with this level are:
- Flat
- Level
- Neutral
- Ok
- Okay
### 1
Good. Words associated with this level are:
- Better
- Fine
- Good
- Positive
- Upbeat
### 2
Very good. Words associated with this level are:
- Amazing
- Awesome
- Elated
- Excellent
- Fantastic
- Great
- Wonderful
### Viewing your feeling history
To view the history simply run `feeling` with no parameters. For now this is
just a simple read-only interface; you can look through years, months and
days, and see the colour-coded overall record for each. In time I aim to add
more features (such as the ability to go back and edit, or remove entries).)
## Data
The data for the application is held in the appropriate [XDG home data
directory for your
platform](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
On Unix-like systems expect to find it in `~/.local/share/feelings`.
## TODO
This is a very early release, where I'm just testing out the basic idea. My
aim is that the data format is already stable (it is quite simple), but the
user interface of the main application may change significantly as I play
around with it.
Things I aim to do:
- [ ] Expand the list of words for the feelings scale.
- [ ] Generally improve the main application user interface.
- [ ] Add the ability to edit items within the main application.
- [ ] Add the ability to remove items within the main application.
## Licence
Feeling - A simple terminal-based feelings tracker
Copyright (C) 2023 Dave Pearson
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": "https://github.com/davep/feeling",
"name": "feeling-cli",
"maintainer": "Dave Pearson",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "davep@davep.org",
"keywords": "terminal,library,feelings",
"author": "Dave Pearson",
"author_email": "davep@davep.org",
"download_url": "",
"platform": null,
"description": "# Feeling\n\n\n\n## Introduction\n\nFeeling is designed to be a simple terminal-based feelings tracker,\nproviding a simple command line interface for recording a feeling at any\ntime, and an application (built with\n[Textual](https://textual.textualize.io/) for reviewing the recorded\nfeelings.\n\n## Installation\n\nFeeling can be installed using [`pipx`](https://pypa.github.io/pipx/):\n\n```sh\n$ pipx install feeling-cli\n```\n\n**NOTE:** The package name (`feeling-cli`) is slightly different from the\nactual application name because the package name wasn't available via PyPi.\n\n## Usage\n\nFeeling is one command that is split into two parts. There is a simple\ncommand line interface for recording a feeling, and a full-screen user\ninterface for looking back over what's been recorded and how it all fits\ntogether and flows.\n\n### Recording a feeling\n\nTo record a feeling, on the command line, just type:\n\n```sh\n$ feeling <rating> <description>\n```\n\nSo, for example:\n\n```sh\n$ feeling good I installed feeling and will use it to track how I feel\n```\n\nThis will make a record for the moment that the feeling is recorded. You can\ndo this as many times as you like. The more you record, the more you'll\nbuild up a record of your day, month, year...\n\nFeeling takes a simple approach of having five levels of feeling, and it\nwill also look for various words that map to those levels (I'll add to them\nover time). The levels and the words associated with them are:\n\n### -2\n\nVery low. Words associated with this level are:\n\n- Horrible\n- Lowest\n- Rubbish\n- Worst\n\n### -1\n\nLow. Words associated with this level are:\n\n- Blah\n- Down\n- Downbeat\n- Low\n- Meh\n- Negative\n\n### 0\n\nNeutral. Words associated with this level are:\n\n- Flat\n- Level\n- Neutral\n- Ok\n- Okay\n\n### 1\n\nGood. Words associated with this level are:\n\n- Better\n- Fine\n- Good\n- Positive\n- Upbeat\n\n### 2\n\nVery good. Words associated with this level are:\n\n- Amazing\n- Awesome\n- Elated\n- Excellent\n- Fantastic\n- Great\n- Wonderful\n\n### Viewing your feeling history\n\nTo view the history simply run `feeling` with no parameters. For now this is\njust a simple read-only interface; you can look through years, months and\ndays, and see the colour-coded overall record for each. In time I aim to add\nmore features (such as the ability to go back and edit, or remove entries).)\n\n## Data\n\nThe data for the application is held in the appropriate [XDG home data\ndirectory for your\nplatform](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).\nOn Unix-like systems expect to find it in `~/.local/share/feelings`.\n\n## TODO\n\nThis is a very early release, where I'm just testing out the basic idea. My\naim is that the data format is already stable (it is quite simple), but the\nuser interface of the main application may change significantly as I play\naround with it.\n\nThings I aim to do:\n\n- [ ] Expand the list of words for the feelings scale.\n- [ ] Generally improve the main application user interface.\n- [ ] Add the ability to edit items within the main application.\n- [ ] Add the ability to remove items within the main application.\n\n## Licence\n\nFeeling - A simple terminal-based feelings tracker \nCopyright (C) 2023 Dave Pearson\n\nThis program is free software: you can redistribute it and/or modify it\nunder the terms of the GNU General Public License as published by the Free\nSoftware Foundation, either version 3 of the License, or (at your option)\nany later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT\nANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\nFITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for\nmore details.\n\nYou should have received a copy of the GNU General Public License along with\nthis program. If not, see <https://www.gnu.org/licenses/>.\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"summary": "A simple feelings recorder and viewer for the terminal, built with Textual",
"version": "0.0.1",
"split_keywords": [
"terminal",
"library",
"feelings"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e4d982f9ab860ee7f1beda85458d34b2faf1f12af1e5b9cf3d49fb4a4b61a13b",
"md5": "de7e8f568d7ef03299f4ae1aebdab0c6",
"sha256": "5b2b5b13b3f50a929f7449cfddcc4346d3fcd674989eb180a014864daa6e83c2"
},
"downloads": -1,
"filename": "feeling_cli-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de7e8f568d7ef03299f4ae1aebdab0c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12560,
"upload_time": "2023-03-16T21:23:10",
"upload_time_iso_8601": "2023-03-16T21:23:10.763755Z",
"url": "https://files.pythonhosted.org/packages/e4/d9/82f9ab860ee7f1beda85458d34b2faf1f12af1e5b9cf3d49fb4a4b61a13b/feeling_cli-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-16 21:23:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "davep",
"github_project": "feeling",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "feeling-cli"
}
JSON
