Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@venvis
venvis authored Jul 8, 2024
1 parent e4814ee commit c87613f
Showing 1 changed file with 186 additions and 3 deletions.
189 changes: 186 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,186 @@
# extraction_libraries
Python library for extracting caselaw data from Cellar.
Full documentation available at [cellar-extractor](https://pypi.org/project/cellar-extractor/).
## Cellar extractor
This library contains two functions to get cellar case law data from eurlex.

## Version
Python 3.9 onwards *

## Tests
![Workflow Status](https://github.com/maastrichtlawtech/extraction_libraries/actions/workflows/github-actions.yml/badge.svg)


## Contributors

<!-- readme: contributors,gijsvd -start -->
<table>
<tr>
<td align="center">
<a href="https://github.com/pranavnbapat">
<img src="https://avatars.githubusercontent.com/u/7271334?v=4" width="100;" alt="pranavnbapat"/>
<br />
<sub><b>Pranav Bapat</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Cloud956">
<img src="https://avatars.githubusercontent.com/u/24865274?v=4" width="100;" alt="Cloud956"/>
<br />
<sub><b>Piotr Lewandowski</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/shashankmc">
<img src="https://avatars.githubusercontent.com/u/3445114?v=4" width="100;" alt="shashankmc"/>
<br />
<sub><b>shashankmc</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/gijsvd">
<img src="https://avatars.githubusercontent.com/u/31765316?v=4" width="100;" alt="gijsvd"/>
<br />
<sub><b>gijsvd</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/venvis">
<img src="https://avatars.githubusercontent.com/venvis" width="100;" alt="venvis"/>
<br />
<sub><b>venvis</b></sub>
</a>
</td>
</tr>
</table>
<!-- readme: contributors,gijsvd -end -->

## How to install?
<code>pip install cellar-extractor</code>

## What are the functions?
<ol>
<li><code>get_cellar</code></li>
Gets all the ECLI data from the eurlex sparql endpoint and saves them in the CSV or JSON format, in-memory or as a saved file.
<br>
<li><code>get_cellar_extra</code></li>
Gets all the ECLI data from the eurlex sparql endpoint, and on top of that scrapes the eurlex websites to acquire
the full text, keywords, case law directory code and eurovoc identifiers. If the user does have an eurlex account with access to the eurlex webservices, he can also
pass his webservices login credentials to the method, in order to extract data about works citing work and works
being cited by work. The full text is returned as a JSON file, rest of data as a CSV. Can be in-memory or as saved files.
<li><code>get_nodes_and_edges_lists</code></li>
Gets 2 list objects, one for the nodes and edges of the citations within the passed dataframe.
Allows the creation of a network graph of the citations. Can only be returned in-memory.
<li><code>filter_subject_matter</code></li>
Returns a dataframe of cases only containing a certain phrase in the column containing the subject of cases.
<li><code>Analyzer</code></li>
A class whose instance(declaration) when called returns a list of the all the text contained within the operative part for each European Court of Justice (CJEU, formerly known as European Court of Justice (ECJ)) judgement (English only).
<li><code>Writing</code></li>
A class which writes the text for the operative part for each European Case law case(En-English only) into csv,json and txt files(Generated upon initialization).<br>
the <code>Writing</code> class has three functions : <br><br>
<ul>
<li><code>to_csv()</code> - Writes the operative part along with celex id into a csv file</li>
<li><code>to_json()</code> - Writes the operative part along with celex id into a json file</li>
<li><code>to_txt()</code> - Writes the operative part along with celex id into a txt file</li>
</ul>
<br>
</ol>

## What are the parameters?
<ol>
<li><code>get_cellar</code></li>
<strong>Parameters:</strong>
<ul>
<li><strong>max_ecli: int, optional, default 100</strong></li>
Maximum number of ECLIs to retrieve.
<li><strong>sd: date, optional, default '2022-05-01'</strong></li>
The start last modification date (yyyy-mm-dd).
<li><strong>ed: date, optional, default current date</strong></li>
The end last modification date (yyyy-mm-dd).
<li><strong>save_file: ['y', 'n'],optional, default 'y'</strong></li>
Save data in a data folder, or return in-memory.
<li><strong>file_format: ['csv', 'json'],optional, default 'csv'</strong></li>
Returns the data as a JSON/dictionary, or as a CSV/Pandas Dataframe object.
</ul>
<li><code>get_cellar_extra</code></li>
<ul>
<li><strong>max_ecli: int, optional, default 100</strong></li>
Maximum number of ECLIs to retrieve.
<li><strong>sd: date, optional, default '2022-05-01'</strong></li>
The start last modification date (yyyy-mm-dd).
<li><strong>ed: date, optional, default current date</strong></li>
The end last modification date (yyyy-mm-dd).
<li><strong>save_file: ['y', 'n'],optional, default 'y'</strong></li>
Save the full text of cases as JSON file / return as a dictionary and save the rest of
the data as a CSV file / return as a Pandas Dataframe object.
<li><strong>threads: int ,optional, default 10</strong></li>
Extracting the additional data takes a lot of time. The use of multi-threading can cut down this time.
Even with this, the method may take a couple of minutes for a couple of hundred cases. A maximum number
of 10 recommended, as this method may also affect the device's internet connection.
<li><strong>username: string, optional, default empty string</strong></li>
The username to the eurlex webservices.
<li><strong>password: string, optional, default empty string</strong></li>
The password to the eurlex webservices.
<br>
</ul>
<li><code>get_nodes_and_edges_lists</code></li>
<ul>
<li><strong>df: DataFrame object, required, default None</strong></li>
DataFrame of cellar metadata acquired from the get_cellar_extra method with eurlex webservice credentials passed.
This method will only work on dataframes with citations data.
<li><strong>only_local: boolean, optional, default False</strong></li>
Flag for nodes and edges generation. If set to True, the network created will only include nodes and edges between
cases exclusively inside the given dataframe.
</ul>
<li><code>filter_subject_matter</code></li>
<ul>
<li><strong>df: DataFrame object, required, default None</strong></li>
DataFrame of cellar metadata acquired from any of the cellar extraction methods listed above.
<li><strong>phrase: string, required, default None</strong></li>
The phrase which has to be present in the subject matter of cases. Case insensitive.
</ul>
<li><code>Analyzer</code></li>
<ul>
<li><strong>celex id: str, required</strong></li>
<li>Pass as a constructor upon initializing the class</li>
</ul>
<li><code>Writing</code></li>
<ul>
<li><strong>celex id: str, required</strong></li>
<li>Pass as a constructor upon initializing the class</li>
</ul>

</ol>


## Examples
```python
import cellar_extractor as cell

Below are examples for in-file saving:

cell.get_cellar(save_file='y', max_ecli=200, sd='2022-01-01', file_format='csv')
cell.get_cellar_extra(max_ecli=100, sd='2022-01-01', threads=10)

Below are examples for in-memory saving:

df = cell.get_cellar(save_file='n', file_format='csv', sd='2022-01-01', max_ecli=1000)
df,json = cell.get_cellar_extra(save_file='n', max_ecli=100, sd='2022-01-01', threads=10)
```
<p>Create a callback of the instance of the class initiated and pass a list as it's value.</p>

```python
import cellar_extractor as cell
instance=cell.Analyzer(celex_id:str)
output_list=instance()
print(output_list) # prints operative part of the Case as a list
```


<p>The Writing Class also takes a celex id , upon initializing the class , through the means of the constructor and writes the content of its operative part into different files , depending on the function called</p>

```python
import cellar_extractor as cell
instance=cell.Writing(celex_id:str)
output=instance.to_csv()#for csv
output=instance.to_txt()#for txt
output=instance.to_json()#for json

```

0 comments on commit c87613f

Please sign in to comment.