title	alternative	description	creator	created	license
Hyp2Rem	Readme	Hypothes.is to RemNote integration	/AUTHORS.md	2020-12-12	/LICENSE

Hyp2Rem

Hypothes.is to RemNote integration

This utility retrieves your Hypothes.is annotations and uploads them as Rems in your RemNote account. In other words, you can easily annotate any web page or PDF using Hypothes.is free and open source collaborative annotation tool while browsing it. Hyp2Rem can then be configured to fetch all your notes and transform your them into Rems in your knowledge base, so that you can enjoy RemNote's backlinking and spaced repetition features.

Table of Contents

• Install
  • Get your credentials
• Usage
  • CLI
• Contributing
• License

Install

You can install the package directly into a virtual environment using pip and a tool like venv.

In Unix/MacOS systems:

python3 -m venv example-env
source example-env/bin/activate
python -m pip install git+https://github.com/inova-mprj/bussola-etl-siafe

In Windows:

python3 -m venv example-env
example-env\Scripts\activate.bat
python -m pip install git+https://github.com/inova-mprj/bussola-etl-siafe

Alternatively, you can use pipx (see pipx documentation on how to install pipx) to handle the environment isolation automagically:

pipx install git+https://github.com/inova-mprj/bussola-etl-siafe

If you plan to use the package as a dependency in your workflow, you can install it using a dependency manager like pipenv or poetry:

# Pipenv
pipenv add git+https://github.com/inova-mprj/bussola-etl-siafe

# Poetry
poetry add git+https://github.com/inova-mprj/bussola-etl-siafe

Get your credentials

Before you can even start to play with Hyp2Rem, you must get some special credentials both in Hypothes.is and RemNote web apps. Follow [this tutorial][/docs/get-access.md] to generate your keys.

Usage

CLI

# Fetch all annotations updated after Jan, 1st 2020 in an annotation group
# named 'RemNote' (case-sensitive)
hyp2rem --hyp-group="RemNote" --sort="updated" --after="2020-01-01"

Contributing

Contributions for this project are welcome.

Check for open issues that might need someone's attention, or open a new issue if you have found a bug or want to propose an enhancement.

To work in a new feature or solve a bug, fork this repository and open a new pull request once you have a working solution for review.

Oh, and please make sure you follow the Code of Conduct in all of your interactions.

License

Copyright 2020 The Hyp2Rem Authors

Use of this source code is governed by an MIT license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.