Update documentation for CI and release info
This commit is contained in:
parent
a4f48bb24e
commit
85f3d9595d
1 changed files with 13 additions and 8 deletions
21
README.md
21
README.md
|
@ -1,8 +1,8 @@
|
|||
# papis-extract
|
||||
|
||||
<!-- TODO have to set up status and badge
|
||||
[![status-badge](https://ci.martyoeh.me/api/badges/Marty/pubs-extract/status.svg)](https://ci.martyoeh.me/Marty/pubs-extract)
|
||||
![PyPI](https://img.shields.io/pypi/v/pubs-extract)
|
||||
[![status-badge](https://ci.martyoeh.me/api/badges/Marty/papis-extract/status.svg)](https://ci.martyoeh.me/Marty/papis-extract)
|
||||
<!-- TODO have to set up pypi badge
|
||||
![PyPI](https://img.shields.io/pypi/v/papis-extract)
|
||||
-->
|
||||
|
||||
Quickly extract annotations from your pdf files with the help of the [papis](https://github.com/papis/papis) bibliography manager.\
|
||||
|
@ -11,11 +11,14 @@ Easily organize all your highlights and thoughts next to your documents and refe
|
|||
## Installation:
|
||||
|
||||
<!-- TODO set up pypi repository / explain git install path -->
|
||||
You can install from pypi with `pip install git+`.
|
||||
You can install from pypi with `pip install git+https://git.martyoeh.me/Marty/papis-extract.git`.
|
||||
|
||||
That's it! If you have papis and papis-extract installed in the same environment (whether virtual or global),
|
||||
everything should now be set up.
|
||||
|
||||
I am currently working towards the first release for pypi, see the below roadmap;
|
||||
when that is done you will also be able to install in the usual pypi way.
|
||||
|
||||
To check if everything is working you should now see the `extract` command listed when running `papis --help`.
|
||||
You will be set up with the default options but if you want to change anything, read on in configuration below.
|
||||
|
||||
|
@ -166,7 +169,7 @@ The option should generally not take too much tuning, but it is there if you nee
|
|||
|
||||
This should generally be an alright default but is here to be changed for example if you work with a lot of different annotation colors (where dark purple and light purple may different meanings) and get false positives in automatic tag recognition, or no tags are recognized at all.
|
||||
|
||||
## Roadmap
|
||||
## Roadmap to first release
|
||||
|
||||
Known issues to be fixed:
|
||||
|
||||
|
@ -183,14 +186,13 @@ features to be implemented:
|
|||
|
||||
- [ ] CICD
|
||||
- [x] static analysis (lint, typecheck etc) on pushes
|
||||
- [ ] test pipeline on master pushes
|
||||
- [x] test pipeline on master pushes
|
||||
- [ ] release pipeline to pypi on tags
|
||||
- [ ] on_add hook to extract annotations as files are added
|
||||
- needs upstream help, 'on_add' hook, and pass-through of affected documents
|
||||
- [ ] add page number if available
|
||||
- exists in Annotation, just need to place in output
|
||||
- [ ] show overall amount of extractions at the end
|
||||
- [ ] custom formatting decided by user
|
||||
- in config as { "myformatter": ">{tag}\n{quote}\n{note}\n{page} etc"}
|
||||
- [ ] improved default exporters
|
||||
- markdown into notes
|
||||
- pretty display on stdout (rich?)
|
||||
|
@ -199,6 +201,9 @@ features to be implemented:
|
|||
- [ ] allow custom colors -> tag name settings not dependent on color name existing (e.g. {"important": (1.0,0.0,0.0)})
|
||||
- [ ] `--overwrite` mode where existing annotations are not dropped but overwritten on same line of note
|
||||
- [ ] `--force` mode where we simply do not drop anything
|
||||
- [ ] `--format` option to choose from default or set up a custom formatter
|
||||
- [ ] on_add hook to extract annotations as files are added
|
||||
- needs upstream help, 'on_add' hook, and pass-through of affected documents
|
||||
|
||||
upstream changes:
|
||||
|
||||
|
|
Loading…
Reference in a new issue