Prepare for PyPI; rename project

This commit is contained in:
Jeffrey Serio 2022-09-30 17:25:05 -05:00
parent 4db49a8de2
commit a194c1d89e
3 changed files with 27 additions and 6 deletions

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
dist
src/*.egg-info

View File

@ -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. This is a little utility I use for logging my daily activities and events. It is written in Python.
## Install ## Install
```bash ```bash
python3 -m pip install elog python3 -m pip install daily-event-logger
``` ```
## Usage ## 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 ```bash
usage: elog [-h] [-v] {add,edit,rm,ls,lsfiles,search} ... usage: elog [-h] [-v] {add,edit,rm,ls,lsfiles,search} ...

View File

@ -2,17 +2,22 @@ from setuptools import setup, find_packages
setup( setup(
name="elog", name="daily-event-logger",
version="0.0.2", version="0.0.3",
license="GPL-3.0", license="GPL-3.0",
author="Jeffrey Serio", author="Jeffrey Serio",
author_email="hyperreal@fedoraproject.org", author_email="hyperreal@fedoraproject.org",
packages=find_packages("src"), packages=find_packages("src"),
package_dir={"": "src"}, package_dir={"": "src"},
url="https://github.com/hyperreal64/elog", url="https://github.com/hyperreal64/daily-event-logger",
keywords="elog", keywords="daily-event-logger",
install_requires=[ install_requires=[
"jsonschema", "jsonschema",
"rich", "rich",
], ],
entry_points={
"console_scripts": [
"elog = elog",
]
},
) )