From a194c1d89ef49cdda3545cd9679d5e876e8ba4eb Mon Sep 17 00:00:00 2001 From: Jeffrey Serio <23226432+hyperreal64@users.noreply.github.com> Date: Fri, 30 Sep 2022 17:25:05 -0500 Subject: [PATCH] Prepare for PyPI; rename project --- .gitignore | 2 ++ README.md | 18 ++++++++++++++++-- setup.py | 13 +++++++++---- 3 files changed, 27 insertions(+), 6 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..98c6fe2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +dist +src/*.egg-info \ No newline at end of file diff --git a/README.md b/README.md index 4f1c76e..359130e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,29 @@ -# elog +# daily-event-logger This is a little utility I use for logging my daily activities and events. It is written in Python. ## Install ```bash -python3 -m pip install elog +python3 -m pip install daily-event-logger ``` ## Usage +To change the directory where elogs are stored, set a shell environment variable ELOG_DIR. To make this change permament, set the following in your shell configuration: + +```bash +export ELOG_DIR="/path/to/elog/dir" +``` + +Otherwise, the default elog directory will be `~/elogs`. + +To get started, add your first elog entry! This will create a JSON file under your elog directory for the day and ensure the elog directory exists. E.g.: + +```bash +elog add -m "Started new elog. Yay!" +``` + ```bash usage: elog [-h] [-v] {add,edit,rm,ls,lsfiles,search} ... diff --git a/setup.py b/setup.py index a8b10ce..9a5a864 100644 --- a/setup.py +++ b/setup.py @@ -2,17 +2,22 @@ from setuptools import setup, find_packages setup( - name="elog", - version="0.0.2", + name="daily-event-logger", + version="0.0.3", license="GPL-3.0", author="Jeffrey Serio", author_email="hyperreal@fedoraproject.org", packages=find_packages("src"), package_dir={"": "src"}, - url="https://github.com/hyperreal64/elog", - keywords="elog", + url="https://github.com/hyperreal64/daily-event-logger", + keywords="daily-event-logger", install_requires=[ "jsonschema", "rich", ], + entry_points={ + "console_scripts": [ + "elog = elog", + ] + }, ) \ No newline at end of file