Linking german legal norms, dependency-free & GDPR-friendly
Project description
py-gesetze
Linking german legal norms, dependency-free & GDPR-friendly. py-gesetze
automatically transforms legal references into a
tags - batteries included.
This project is a Python port of the PHP library php-gesetze
.
Installation
It's available from PyPi using pip
:
pip install gesetze
Getting started
Using this library is straightforward.
Commandline
Pretty much self-explanatory - otherwise, --help
is your friend:
$ gesetze --help
Usage: gesetze [OPTIONS] COMMAND [ARGS]...
Utilities for indexing & analyzing german legal norms
Options:
-v, --verbose Enable verbose mode.
--version Show the version and exit.
--help Show this message and exit.
Commands:
analyze Analyzes legal norm
build Builds index
clear Clears download cache
Package
The underlying module may also be used directly:
from gesetze import Gesetz, analyze
# Initialize it
obj = Gesetz()
# Configure it
obj.title = 'normal'
# Convert legal references
print(obj.gesetzify('This text references Art. 1 GG.'))
# "This text references <a class="hover:underline" href="https://www.gesetze-im-internet.de/gg/art_1.html" title="Grundgesetz für die Bundesrepublik Deutschland">Art. 1 GG</a>."
print(analyze('§ 433 Abs. 2 BGB'))
# {'norm': '433', 'absatz': '2', 'gesetz': 'BGB'}
Usage
Class Gesetz
__init__(drivers: typing.Union[str, list])
drivers
controls the providers (and their respective order) to be used, either str
or list
.
Note: This defaults to all available drivers, which is a good overall choice, simply because of the vast array of supported laws. However, possible values are gesetze
, 'dejure'
, 'buzer'
and 'lexparency'
.
gesetzify(string: str, callback: typing.Callable) -> str
Transforms legal references into HTML link tags
Note: For more flexibility, you may use your own callback
method as second parameter of gesetzify
. Callbacks are being passed the re.Match
object representing matched legal norms. This way, you could highlight them using <strong>
tags instead of converting them into a
tags. Default: obj.linkify
Example: Inside the callback function, the match
for '§ 433 Abs. 2 BGB' (match.group(0)
) would give a dictionary like {'norm': '433', 'absatz': '2', 'satz': None, 'nr': None, 'lit': None, 'gesetz': 'BGB'}
(eg using match.groupdict()
).
Note: For convenience, a Markdown callback is included and may be used like this: obj.gesetzify('your-text', obj.markdownify)
Helpers
analyze(string: str) -> dict
Analyzes a single legal norm
extract(string: str) -> list
Extracts legal norms as list of strings
roman2arabic(string: str)
Converts roman numerals to arabic numerals (static method)
Configuration
The gesetzify
command may be configured through the following options:
obj.attributes (dict)
Defines HTML attribute defaults. Default: {'target': '_blank'}
obj.title (False|str)
Controls title
attribute. Default: False
Possible values:
light
: abbreviated law (eg 'GG')normal
: complete law (eg 'Grundgesetz')full
: official heading (eg 'Art 45d Parlamentarisches Kontrollgremium')
Contributing
If you want to get your hands dirty, this will download the repository and install py-gesetze
along its dependencies inside a virtual environment, ready for action:
# Clone repository & change directory
git clone https://codeberg.org/S1SYPHOS/py-gesetze && cd py-gesetze
# Set up & activate virtualenv
poetry shell
# Install dependencies
poetry install
Credits
This library is based on ..
- .. an adapted (and somewhat improved) version of the
jura_regex
regex package by Philipp Kiersch. - .. an adapted (and somewhat modified) version of the
gesetze
crawler package by Matej Grahovac.
Special Thanks
I'd like to thank everybody that's making free & open source software - you people are awesome. Also I'm always thankful for feedback and bug reports :)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file gesetze-1.2.1.tar.gz
.
File metadata
- Download URL: gesetze-1.2.1.tar.gz
- Upload date:
- Size: 4.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.1 CPython/3.10.4 Linux/5.19.0-76051900-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63faa7ac43b6693c08fa5901180b2999b429fd775b84300bf6496ce32ff42c6c |
|
MD5 | f91efdc4c169b3b6f66f44d9c416737a |
|
BLAKE2b-256 | 38c45444e38e7cd90fd952041581c9301000cac316bed92207df12c811ec3a3c |
File details
Details for the file gesetze-1.2.1-py3-none-any.whl
.
File metadata
- Download URL: gesetze-1.2.1-py3-none-any.whl
- Upload date:
- Size: 4.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.1 CPython/3.10.4 Linux/5.19.0-76051900-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbe2fe7aff6adc3d4283d7b2f4cbe823656f1a26b63c1f98031b826785418490 |
|
MD5 | 60796ff2f6ea06b2aa38a8dd2e8b3943 |
|
BLAKE2b-256 | 340151bb61fcd0986fa18438155d7e8169529c7cbdd8a03d2da0fcb00ee4a7e2 |