# greatday
**Don't have a good day. Have a great day.**
_project status badges:_
[](https://github.com/bbugyi200/greatday/actions/workflows/ci.yml)
[](https://codecov.io/gh/bbugyi200/greatday)
[](https://greatday.readthedocs.io/en/latest/?badge=latest)
[](https://snyk.io/advisor/python/greatday)
_version badges:_
[](https://pypi.org/project/greatday/)
[](https://pypi.org/project/greatday/)
[](https://github.com/python-boltons/cc-python)
[](https://github.com/python-boltons/docker-python)
## Installation 🗹
### Using `pipx` to Install (preferred)
This package _could_ be installed using pip like any other Python package (in
fact, see the section below this one for instructions on how to do just that).
Given that we only need this package's entry points, however, we recommend that
[pipx][11] be used instead:
```shell
# install and setup pipx
python3 -m pip install --user pipx
python3 -m pipx ensurepath
# install greatday
pipx install greatday
```
### Using `pip` to Install
To install `greatday` using [pip][9], run the following
commands in your terminal:
``` shell
python3 -m pip install --user greatday # install greatday
```
If you don't have pip installed, this [Python installation guide][10] can guide
you through the process.
## Command-Line Interface (CLI)
The output from running `greatday --help` is shown below:
<!-- [[[[[kooky.cog
import subprocess
popen = subprocess.Popen(["greatday", "--help"], stdout=subprocess.PIPE)
stdout, _ = popen.communicate()
print("```", stdout.decode().strip(), "```", sep="\n")
]]]]] -->
```
usage: greatday [-h] [-c CONFIG_FILE] [-L [FILE[:LEVEL][@FORMAT]]] [-v]
[--version]
{add,list,tui} ...
Don't have a good day. Have a great day.
optional arguments:
-c CONFIG_FILE, --config CONFIG_FILE
Absolute or relative path to a YAML file that contains
this application's configuration.
-h, --help show this help message and exit
-L [FILE[:LEVEL][@FORMAT]], --log [FILE[:LEVEL][@FORMAT]]
This option can be used to enable a new logging
handler. FILE should be either a path to a logfile or
one of the following special file types: [1] 'stderr'
to log to standard error (enabled by default), [2]
'stdout' to log to standard out, [3] 'null' to disable
all console (e.g. stderr) handlers, or [4] '+[NAME]'
to choose a default logfile path (where NAME is an
optional basename for the logfile). LEVEL can be any
valid log level (i.e. one of ['CRITICAL', 'DEBUG',
'ERROR', 'INFO', 'TRACE', 'WARNING']) and FORMAT can
be any valid log format (i.e. one of ['color', 'json',
'nocolor']). NOTE: This option can be specified
multiple times and has a default argument of '+'.
-v, --verbose How verbose should the output be? This option can be
specified multiple times (e.g. -v, -vv, -vvv, ...).
--version show program's version number and exit
subcommands:
{add,list,tui}
add Add a new todo to your inbox.
list Query the todo database.
tui Render greatday's text-based user interface (TUI).
This is the default command.
```
<!-- [[[[[end]]]]] -->
<!-- [[[[[kooky.cog
from pathlib import Path
design_md = Path("./docs/design/design.md")
if design_md.exists():
lines = design_md.read_text().split("\n")
if any(L.strip() for L in lines):
fixed_lines = [L.replace("(.", "(./docs/design") if L.startswith("![") else L for L in lines]
print("## Design Diagrams\n")
print("\n".join(fixed_lines))
]]]]] -->
<!-- [[[[[end]]]]] -->
## Useful Links 🔗
* [API Reference][3]: A developer's reference of the API exposed by this
project.
* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.
Changes made to this cookiecutter are periodically synced with this project
using [cruft][12].
* [CHANGELOG.md][2]: We use this file to document all notable changes made to
this project.
* [CONTRIBUTING.md][7]: This document contains guidelines for developers
interested in contributing to this project.
* [Create a New Issue][13]: Create a new GitHub issue for this project.
* [Documentation][1]: This project's full documentation.
[1]: https://greatday.readthedocs.io/en/latest
[2]: https://github.com/bbugyi200/greatday/blob/master/CHANGELOG.md
[3]: https://greatday.readthedocs.io/en/latest/modules.html
[4]: https://github.com/python-boltons/cc-python
[5]: https://github.com/cookiecutter/cookiecutter
[6]: https://docs.readthedocs.io/en/stable/
[7]: https://github.com/bbugyi200/greatday/blob/master/CONTRIBUTING.md
[8]: https://github.com/bbugyi200/greatday
[9]: https://pip.pypa.io
[10]: http://docs.python-guide.org/en/latest/starting/installation/
[11]: https://github.com/pypa/pipx
[12]: https://github.com/cruft/cruft
[13]: https://github.com/bbugyi200/greatday/issues/new/choose
Raw data
{
"_id": null,
"home_page": "https://github.com/bbugyi200/greatday",
"name": "greatday",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Bryan M Bugyi",
"author_email": "bryanbugyi34@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b7/ba/565d5a2d384755b494026f3ea677fb0487331468eeca6eab4883f8937df1/greatday-1.1.0.tar.gz",
"platform": null,
"description": "# greatday\n\n**Don't have a good day. Have a great day.**\n\n_project status badges:_\n\n[](https://github.com/bbugyi200/greatday/actions/workflows/ci.yml)\n[](https://codecov.io/gh/bbugyi200/greatday)\n[](https://greatday.readthedocs.io/en/latest/?badge=latest)\n[](https://snyk.io/advisor/python/greatday)\n\n_version badges:_\n\n[](https://pypi.org/project/greatday/)\n[](https://pypi.org/project/greatday/)\n[](https://github.com/python-boltons/cc-python)\n[](https://github.com/python-boltons/docker-python)\n\n\n## Installation \ud83d\uddf9\n\n### Using `pipx` to Install (preferred)\n\nThis package _could_ be installed using pip like any other Python package (in\nfact, see the section below this one for instructions on how to do just that).\nGiven that we only need this package's entry points, however, we recommend that\n[pipx][11] be used instead:\n\n```shell\n# install and setup pipx\npython3 -m pip install --user pipx\npython3 -m pipx ensurepath\n\n# install greatday\npipx install greatday\n```\n\n### Using `pip` to Install\n\nTo install `greatday` using [pip][9], run the following\ncommands in your terminal:\n\n``` shell\npython3 -m pip install --user greatday # install greatday\n```\n\nIf you don't have pip installed, this [Python installation guide][10] can guide\nyou through the process.\n\n\n## Command-Line Interface (CLI)\n\nThe output from running `greatday --help` is shown below:\n\n<!-- [[[[[kooky.cog\nimport subprocess\n\npopen = subprocess.Popen([\"greatday\", \"--help\"], stdout=subprocess.PIPE)\nstdout, _ = popen.communicate()\nprint(\"```\", stdout.decode().strip(), \"```\", sep=\"\\n\")\n]]]]] -->\n```\nusage: greatday [-h] [-c CONFIG_FILE] [-L [FILE[:LEVEL][@FORMAT]]] [-v]\n [--version]\n {add,list,tui} ...\n\nDon't have a good day. Have a great day.\n\noptional arguments:\n -c CONFIG_FILE, --config CONFIG_FILE\n Absolute or relative path to a YAML file that contains\n this application's configuration.\n -h, --help show this help message and exit\n -L [FILE[:LEVEL][@FORMAT]], --log [FILE[:LEVEL][@FORMAT]]\n This option can be used to enable a new logging\n handler. FILE should be either a path to a logfile or\n one of the following special file types: [1] 'stderr'\n to log to standard error (enabled by default), [2]\n 'stdout' to log to standard out, [3] 'null' to disable\n all console (e.g. stderr) handlers, or [4] '+[NAME]'\n to choose a default logfile path (where NAME is an\n optional basename for the logfile). LEVEL can be any\n valid log level (i.e. one of ['CRITICAL', 'DEBUG',\n 'ERROR', 'INFO', 'TRACE', 'WARNING']) and FORMAT can\n be any valid log format (i.e. one of ['color', 'json',\n 'nocolor']). NOTE: This option can be specified\n multiple times and has a default argument of '+'.\n -v, --verbose How verbose should the output be? This option can be\n specified multiple times (e.g. -v, -vv, -vvv, ...).\n --version show program's version number and exit\n\nsubcommands:\n {add,list,tui}\n add Add a new todo to your inbox.\n list Query the todo database.\n tui Render greatday's text-based user interface (TUI).\n This is the default command.\n```\n<!-- [[[[[end]]]]] -->\n\n<!-- [[[[[kooky.cog\nfrom pathlib import Path\n\ndesign_md = Path(\"./docs/design/design.md\")\nif design_md.exists():\n lines = design_md.read_text().split(\"\\n\")\n if any(L.strip() for L in lines):\n fixed_lines = [L.replace(\"(.\", \"(./docs/design\") if L.startswith(\"![\") else L for L in lines]\n print(\"## Design Diagrams\\n\")\n print(\"\\n\".join(fixed_lines))\n]]]]] -->\n<!-- [[[[[end]]]]] -->\n\n\n## Useful Links \ud83d\udd17\n\n* [API Reference][3]: A developer's reference of the API exposed by this\n project.\n* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.\n Changes made to this cookiecutter are periodically synced with this project\n using [cruft][12].\n* [CHANGELOG.md][2]: We use this file to document all notable changes made to\n this project.\n* [CONTRIBUTING.md][7]: This document contains guidelines for developers\n interested in contributing to this project.\n* [Create a New Issue][13]: Create a new GitHub issue for this project.\n* [Documentation][1]: This project's full documentation.\n\n\n[1]: https://greatday.readthedocs.io/en/latest\n[2]: https://github.com/bbugyi200/greatday/blob/master/CHANGELOG.md\n[3]: https://greatday.readthedocs.io/en/latest/modules.html\n[4]: https://github.com/python-boltons/cc-python\n[5]: https://github.com/cookiecutter/cookiecutter\n[6]: https://docs.readthedocs.io/en/stable/\n[7]: https://github.com/bbugyi200/greatday/blob/master/CONTRIBUTING.md\n[8]: https://github.com/bbugyi200/greatday\n[9]: https://pip.pypa.io\n[10]: http://docs.python-guide.org/en/latest/starting/installation/\n[11]: https://github.com/pypa/pipx\n[12]: https://github.com/cruft/cruft\n[13]: https://github.com/bbugyi200/greatday/issues/new/choose\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Don't have a good day. Have a great day.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/bbugyi200/greatday"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c223fa0ad8cea23aa0120c0ab3b10637ae8aa11faa442ca396ca148c676003a",
"md5": "63c88f2746860969aaf652cc4494a65d",
"sha256": "8616eb97a20fddb1c381b5a3bf9515b83400a5f68848a617f6f21215ee2151c1"
},
"downloads": -1,
"filename": "greatday-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63c88f2746860969aaf652cc4494a65d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 31700,
"upload_time": "2023-06-02T02:21:02",
"upload_time_iso_8601": "2023-06-02T02:21:02.042510Z",
"url": "https://files.pythonhosted.org/packages/2c/22/3fa0ad8cea23aa0120c0ab3b10637ae8aa11faa442ca396ca148c676003a/greatday-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b7ba565d5a2d384755b494026f3ea677fb0487331468eeca6eab4883f8937df1",
"md5": "3657a905fec39771a585fe32f6b93f42",
"sha256": "66c32ff9158c94676065c3c42a612996454333e723889343f2462b1f191368b1"
},
"downloads": -1,
"filename": "greatday-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3657a905fec39771a585fe32f6b93f42",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 61474,
"upload_time": "2023-06-02T02:21:03",
"upload_time_iso_8601": "2023-06-02T02:21:03.818546Z",
"url": "https://files.pythonhosted.org/packages/b7/ba/565d5a2d384755b494026f3ea677fb0487331468eeca6eab4883f8937df1/greatday-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-02 02:21:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bbugyi200",
"github_project": "greatday",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "greatday"
}
JSON
