Marty/habitmove
1
0
Fork 0
Code Issues 9 Pull requests Projects Releases 1 Wiki Activity

Add install instructions to README

Browse source
This commit is contained in:
Marty Oehme 2022-01-05 13:16:19 +01:00
parent 59377796f0
commit 5452814501
Signed by: Marty
GPG key ID: B7538B8F50A1C800
1 changed files with 37 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -1,15 +1,34 @@
# habit-migrate
# habitmove
Can take an export of nomie habits in json format and convert it to be importable in Loop Habit Tracker.
Takes habit in one habit-tracking application and transforms them ready to use for another.
Currently can take an export of nomie habits in json format and convert it to be importable in Loop Habit Tracker.
Plans for reverse migration are on the roadmap, and ultimately this tool ideally understands more and more habit formats to prevent app lock-in.
Confirmed working for nomie version 5.6.4 and Loop Habit Tracker version 2.0.2 and 2.0.3.
Presumably works for other nomie 5.x versions and other Loop 2.x versions as well,
but that is untested.
## Installation
Installation can be accomplished through *pip*:
```bash
pip install habitmove
```
Requirements:
`habitmove` requires at least Python 3.7.
It has only been tested on GNU/Linux (amd64) though it should work on other platforms.
## Usage
Run as a commandline utility habit migrate currently takes a single argument, the nomie database `.json` file.
The output as importable Loop Habit Tracker database will be written to `output.db` in present working directory.
Run as a cli utility `habitmove` currently takes a single argument: the nomie database `.json` file to import habits from.
Invoked like: `habitmove nomie-export.json`.
The output as a Loop Habit Tracker database will be written to `output.db` in the present working directory.
Can also take an existing Loop Habit database (exported from the application),
and add the nomie exported habits and checkmarks to it.
@ -18,17 +37,24 @@ it will not (should not™️) overwrite anything.
If there are any duplicated habits however,
it will add duplications of the existing repetitions into the database.
Invoked like: `python run.py nomie-export.json`.
Note, however, that -- until a packaged version is released -- you will need to have some packages in your environment.
If you wish to run it un-packaged, install [poetry](https://python-poetry.org/) and let it do all dependency management by doing:
## Development
```
To enable easy development on the app,
install [poetry](https://python-poetry.org/) and let it do all dependency management for you by doing:
```bash
poetry install
poetry run habitmove <nomie-json>
```
In the future there might be an easier road to using this package but that's the way it is for now.
To see a set up more closely resembling the final cli environment,
with its libraries loaded as environmental dependencies enter the poetry shell:
The package can also be used as a library to load nomie data
or move data into Loop Habit Tracker.
```bash
poetry shell
```
The package can eventually also be used as a library to load nomie data to work with in Python,
or to move data into Loop Habit Tracker.
Take a look at the `Parser` and `Transformer` interfaces respectively.