rechtspraak-extractor 1.5.2

Library for extracting rechtspraak data

Rechtspraak extractor

This library contains two functions to get rechtspraak data and metadata from the API.

Version

Python 3.9+

Contributors

Pranav Bapat

running-machin

Piotr Lewandowski

shashankmc

gijsvd

How to install?

pip install rechtspraak_extractor

What are the functions?

Rechtspraak Extractor

1. get_rechtspraak
Gets all the ECLIs and saves them in the CSV file or in-memory.
It gets, ECLI, title, summary, updated date, link.
2. get_rechtspraak_metadata
Gets the metadata of the ECLIs created by above function and saves them in the new CSV file or in-memory.
Link attribute that we get from the above function contains the links of ECLI metadata.
It gets instantie, datum uitspraak, datum publicatie, zaaknummer, rechtsgebieden, bijzondere kenmerken, inhoudsindicatie, and vindplaatsen

What are the parameters?

1. get_rechtspraak(max_ecli=100, sd='2022-05-01', ed='2022-10-01', save_file='y')
Parameters:
• max_ecli: int, optional
Maximum amount of ECLIs to retrieve
Default: 100
• sd: date, optional, default '2022-08-01'
The start publication date (yyyy-mm-dd)
• ed: date, optional, default current date
The end publication date (yyyy-mm-dd)
• save_file: ['y', 'n'], default 'y'
y - Save data as a CSV file in data folder
n - Save data as a dataframe in-memory
2. get_rechtspraak_metadata
• save_file: ['y', 'n'], default 'y'
y - Save data as a CSV file in data folder
n - Save data as a dataframe in-memory
• dataframe: dataframe, optional
Dataframe containing ECLIs to retrieve metadata. Cannot be combined with filename
• filename: string, optional
CSV file containing ECLIs to retrieve metadata. Cannot be combined with dataframe

Examples

import rechtspraak_extractor as rex

-----------------------------------------------------------------------------------------------------------------------

# For rechtspraak

# To get the rechtspraak data in a dataframe:
df = rex.get_rechtspraak(max_ecli=100, sd='2022-08-01', save_file='n')  # Gets 100 ECLIs from 1st August 2022

# To save rechtspraak data as a CSV file:
rex.get_rechtspraak(max_ecli=100, sd='2022-08-01', save_file='y') 

-----------------------------------------------------------------------------------------------------------------------

# For rechtspraak metadata

# To get metadata as a dataframe from rechtspraak data (as a dataframe):
df_metadata = rex.get_rechtspraak_metadata(save_file='n', dataframe=df)

# To get metadata as a dataframe from rechtspraak file (as a dataframe):
df_metadata = rex.get_rechtspraak_metadata(save_file='n', filename='rechtspraak.csv')

# To get metadata as a dataframe from rechtspraak data (saved as CSV file):
rex.get_rechtspraak_metadata(save_file='y', dataframe=df)

# To get metadata and save as a CSV file:
rex.get_rechtspraak_metadata(save_file='y', filename='rechtspraak.csv')

-----------------------------------------------------------------------------------------------------------------------

# filename='rechtspraak.csv' - filename.csv is a file from the data folder created by get_rechtspraak method
# dataframe=df - df is a dataframe created by get_rechtspraak method

# Will not get any metadata
df = rex.get_rechtspraak_metadata(save_file='n')

# Will get the metadata of all the files in the data folder
rex.get_rechtspraak_metadata(save_file='y')

License

Previously under the MIT License, as of 28/10/2022 this work is licensed under a Apache License, Version 2.0.

Apache License, Version 2.0

Copyright (c) 2022 Maastricht Law & Tech Lab

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    
    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.