Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkaz/oneliner
A command-line tool for saving one line notes in plain text files.
https://github.com/mkaz/oneliner
Last synced: about 2 months ago
JSON representation
A command-line tool for saving one line notes in plain text files.
- Host: GitHub
- URL: https://github.com/mkaz/oneliner
- Owner: mkaz
- Created: 2022-12-10T14:39:31.000Z (almost 2 years ago)
- Default Branch: trunk
- Last Pushed: 2023-03-12T05:19:58.000Z (over 1 year ago)
- Last Synced: 2024-05-29T05:14:04.186Z (4 months ago)
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# oneliner
A simple command-line tool for saving one line notes in plain text files.
## Example
Use `oneliner` by adding note on the command-line
```
$ oneliner "Here is my note"
```
## Install
**Step 1:** Install - Three options to install
```
python3 -m pip install git+https://github.com/mkaz/oneliner
```
**Step 2:** Create oneliner.conf, see [Configuration below](#configuration)
## Usage
See `oneliner --help` for help.
Add one line note to default file with today's date
```
oneliner 'This is my note'
```
Forgot to record yesterday, use `--yesterday` flag to use previous date
```
oneline --yesterday "This is my note for yesterday"
```
Multiple journals, use `--journal` flag, requires config
```
oneliner -j movies '😱 Halloween 1978'
```
## Configuration
The config file is in TOML format.
The only required parameter in the `oneliner.conf` config is the `path` which specifies where to save the notes file. The other parameters, if not specified, will use their defaults.
To save to multiple journals, use a `[journals]` section in the config file and specify a journal_path and journal_filename, where "journal" would be the flagged passed in. For example, to create a movies journal specify `movies_path` and `movies_filename` and then use `-j movies` flag.
### Where to put the config
The program looks for the config file using the following:
1. Command-line argument. Use `oneliner --conf /path/to/oneliner.conf`
2. Look for platform config directory
a. Linux: `${XDG_CONFIG_HOME}/oneliner.conf`
b. Windows: `${APPDATA}/oneliner.conf`
3. Look for `${HOME}/.config/oneliner.conf`
4. Current directions `./oneliner.conf`
If not specified or found in any of the above locations, `oneliner` will error out with a message to set the configuration file.
### Sample Config
You can generate a sample config using: `oneliner --sample`
```toml
# oneliner config file
# Base directory that all notes are stored
# Use full path for directory
path = '/Users/mkaz/Documents/'
# Default filename
filename = 'oneliner-%Y.txt'
# Format for date prefix before each line
# 2022-12-01 | YOUR NOTE HERE
prefix = '%Y-%m-%d'
# Multiple Journals
# Use: oneliner -j movies '😱 Halloween 1978'
[journals]
[journals.movies]
filename = 'movies-%Y.txt'
path = '/Users/mkaz/Documents/Lists'
# For time parameters see:
# https://docs.rs/chrono/0.4.0/chrono/format/strftime/index.html
```
## License
Oneliner is open-source and free to use, it is licensed under a [MIT License](https://opensource.org/licenses/MIT)
I welcome contributions, but as a side project I may not always respond promptly. Please feel free to open an issues to report a bug, submit a feature, or even a pull request.