Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spehnm/anki-de-law-lookup
Anki add-on, that automatically looks up legal references when a specific shortcut is pressed during card review.
https://github.com/spehnm/anki-de-law-lookup
anki anki-addon law legal-reference
Last synced: about 1 month ago
JSON representation
Anki add-on, that automatically looks up legal references when a specific shortcut is pressed during card review.
- Host: GitHub
- URL: https://github.com/spehnm/anki-de-law-lookup
- Owner: spehnm
- License: gpl-3.0
- Created: 2024-07-03T10:45:56.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T10:06:59.000Z (6 months ago)
- Last Synced: 2024-10-31T05:05:26.424Z (3 months ago)
- Topics: anki, anki-addon, law, legal-reference
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LawLookup Addon for Anki
This Anki addon automatically looks up legal references in German law texts and opens the corresponding webpage when a specific shortcut - by default `#` - is pressed during card review. The addon uses a tokenizer to identify legal references in the front text of a card and opens the corresponding law section on gesetze-im-internet.de. It uses the citation guideline by the German Federal Administrative Court.
## Features (mind that this is the launch version)
- Identifies legal references in German legal texts, if you followed the German Federal Administrative Court citation style.
- Opens the corresponding law section on gesetze-im-internet.de.
- Activation via a customizable keyboard shortcut during card review.
## Installation
0. **(Easy way:) Check out the Anki Addon Website**
https://ankiweb.net/shared/info/135761574 (the add-on code you can simply input is: 135761574)
1. **Clone the repository:**
```sh
git clone https://github.com/yourusername/law_lookup.git
```
2. **Navigate to the Anki addons directory:**
- On Windows: `C:\Users\\AppData\Roaming\Anki2\addons21`
- On macOS: `~/Library/Application Support/Anki2/addons21`
- On Linux: `~/.local/share/Anki2/addons21`
3. **Copy the `law_lookup` directory into the `addons21` directory:**
```sh
cp -r law_lookup
```
## Usage
1. **Open Anki and start reviewing your cards.**
2. **Press the `#` key during card review to open the corresponding law section.**
## What's next?
Currently, I'm working on a bugfix appearing on non-Windows systems. I think my next step will be to account for different citation styles (e.g. § 771 II ZPO instead of § 771 Abs. 2 ZPO).
## Customization
If you wish to change the shortcut key, you can modify the `setup_shortcut` method in the `lookup.py` file.
Example to change the shortcut to `+`:
```python
shortcut = QShortcut(QKeySequence("+"), mw)