rechtspraak-citations-extractor


Namerechtspraak-citations-extractor JSON
Version 1.0.13 PyPI version JSON
download
home_page
SummaryLibrary for extracting rechtspraak citations via LIDO
upload_time2023-09-27 12:49:22
maintainer
docs_urlNone
authorLawTech Lab
requires_python
licenseMIT
keywords rechtspraak citations rechtspraak citations rs citations
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Rechtspraak citations
This library contains a function that aqcuires citation data for Rechtspraak cases using the LIDO.

## Version
Python 3.9

## Contributors

<!-- readme: contributors,gijsvd -start -->
<table>
<tr>
    <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>
</tr>
</table>
<!-- readme: contributors,gijsvd -end -->

## How to install?
<code>pip install rechtspraak_citations_extractor</code>

## What are the functions?
<li><b>Rechtspraak Citations Extractor</b>
<ol>
    <li><code>get_citations</code></li>
    Gets all the data about case law citing/being cited and the legislations cited from the cases 
    in passed on DataFrame of case metadata. Requires a valid DataFrame object with a column titled 'ecli'. Returns the same Dataframe object,
     with 3 additional columns containing JSON strings of citation information.
</ol> </li>

## What are the parameters?
<ol>
    <li><strong>get_citations(dataframe = None, username = '', password = '', threads = 2)</strong></li>
    <strong>Parameters:</strong>
    <ul>
        <li><strong>dataframe: Pandas DataFrame object, required</strong></li>
        A Dataframe object, which must have a column titled 'ecli'. 
        The code extracts citations for each separate ECLI in the column. 
        A Dataframe with Rechtspraak data can be aqcuired via the rechtspraak extractor - https://pypi.org/project/rechtspraak-extractor
        <br>Default: None
        <li><strong>username: string, required, default ''</strong></li>
        The username that together with the password can be used to log into LIDO.
        <li><strong>password: string, required, default ''</strong></li>
        The password that together with the username can be used to log into LIDO.
        <li><strong>threads: int, optional, default 1</strong></li>
        Option for multi-threading of LiDO requests - not recommended to go above 2, as LiDO breaks connections when overwhelmed.
    </ul>
</ol>


## Examples
```
import rechtspraak_extractor as rex
import rechtspraak_citations_extractor as rex_citations
-----------------------------------------------------------------------------------------------------------------------

# To get the rechtspraak data in a dataframe:
df = rex.get_rechtspraak(max_ecli=100, sd='2022-08-01', save_file='y')  # Gets 100 ECLIs from 1st August 2022
df = get_rechtspraak_metadata(save_file='n',dataframe=df)
# To get the citations:
df_with_citaitons = rex_citations.get_citations(df,'username','password')
```


## License
[![License: Apache 2.0](https://img.shields.io/github/license/maastrichtlawtech/extraction_libraries)](https://opensource.org/licenses/Apache-2.0)

Previously under the [MIT License](https://opensource.org/licenses/MIT), as of 28/10/2022 this work is licensed under a [Apache License, Version 2.0](https://opensource.org/licenses/Apache-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.
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "rechtspraak-citations-extractor",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "rechtspraak,citations,rechtspraak citations,RS citations",
    "author": "LawTech Lab",
    "author_email": "p.lewandowski@student.maastrichtuniversity.nl",
    "download_url": "https://files.pythonhosted.org/packages/df/50/cb27d85324bd4a823bd59eff2cf746bab14ea1f563e2f47017f8a068845d/rechtspraak_citations_extractor-1.0.13.tar.gz",
    "platform": null,
    "description": "## Rechtspraak citations\r\nThis library contains a function that aqcuires citation data for Rechtspraak cases using the LIDO.\r\n\r\n## Version\r\nPython 3.9\r\n\r\n## Contributors\r\n\r\n<!-- readme: contributors,gijsvd -start -->\r\n<table>\r\n<tr>\r\n    <td align=\"center\">\r\n        <a href=\"https://github.com/Cloud956\">\r\n            <img src=\"https://avatars.githubusercontent.com/u/24865274?v=4\" width=\"100;\" alt=\"Cloud956\"/>\r\n            <br />\r\n            <sub><b>Piotr Lewandowski</b></sub>\r\n        </a>\r\n    </td>\r\n    <td align=\"center\">\r\n        <a href=\"https://github.com/shashankmc\">\r\n            <img src=\"https://avatars.githubusercontent.com/u/3445114?v=4\" width=\"100;\" alt=\"shashankmc\"/>\r\n            <br />\r\n            <sub><b>shashankmc</b></sub>\r\n        </a>\r\n    </td>\r\n    <td align=\"center\">\r\n        <a href=\"https://github.com/gijsvd\">\r\n            <img src=\"https://avatars.githubusercontent.com/u/31765316?v=4\" width=\"100;\" alt=\"gijsvd\"/>\r\n            <br />\r\n            <sub><b>gijsvd</b></sub>\r\n        </a>\r\n    </td>\r\n</tr>\r\n</table>\r\n<!-- readme: contributors,gijsvd -end -->\r\n\r\n## How to install?\r\n<code>pip install rechtspraak_citations_extractor</code>\r\n\r\n## What are the functions?\r\n<li><b>Rechtspraak Citations Extractor</b>\r\n<ol>\r\n    <li><code>get_citations</code></li>\r\n    Gets all the data about case law citing/being cited and the legislations cited from the cases \r\n    in passed on DataFrame of case metadata. Requires a valid DataFrame object with a column titled 'ecli'. Returns the same Dataframe object,\r\n     with 3 additional columns containing JSON strings of citation information.\r\n</ol> </li>\r\n\r\n## What are the parameters?\r\n<ol>\r\n    <li><strong>get_citations(dataframe = None, username = '', password = '', threads = 2)</strong></li>\r\n    <strong>Parameters:</strong>\r\n    <ul>\r\n        <li><strong>dataframe: Pandas DataFrame object, required</strong></li>\r\n        A Dataframe object, which must have a column titled 'ecli'. \r\n        The code extracts citations for each separate ECLI in the column. \r\n        A Dataframe with Rechtspraak data can be aqcuired via the rechtspraak extractor - https://pypi.org/project/rechtspraak-extractor\r\n        <br>Default: None\r\n        <li><strong>username: string, required, default ''</strong></li>\r\n        The username that together with the password can be used to log into LIDO.\r\n        <li><strong>password: string, required, default ''</strong></li>\r\n        The password that together with the username can be used to log into LIDO.\r\n        <li><strong>threads: int, optional, default 1</strong></li>\r\n        Option for multi-threading of LiDO requests - not recommended to go above 2, as LiDO breaks connections when overwhelmed.\r\n    </ul>\r\n</ol>\r\n\r\n\r\n## Examples\r\n```\r\nimport rechtspraak_extractor as rex\r\nimport rechtspraak_citations_extractor as rex_citations\r\n-----------------------------------------------------------------------------------------------------------------------\r\n\r\n# To get the rechtspraak data in a dataframe:\r\ndf = rex.get_rechtspraak(max_ecli=100, sd='2022-08-01', save_file='y')  # Gets 100 ECLIs from 1st August 2022\r\ndf = get_rechtspraak_metadata(save_file='n',dataframe=df)\r\n# To get the citations:\r\ndf_with_citaitons = rex_citations.get_citations(df,'username','password')\r\n```\r\n\r\n\r\n## License\r\n[![License: Apache 2.0](https://img.shields.io/github/license/maastrichtlawtech/extraction_libraries)](https://opensource.org/licenses/Apache-2.0)\r\n\r\nPreviously under the [MIT License](https://opensource.org/licenses/MIT), as of 28/10/2022 this work is licensed under a [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0).\r\n```\r\nApache License, Version 2.0\r\n\r\nCopyright (c) 2022 Maastricht Law & Tech Lab\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n    \r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n```\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Library for extracting rechtspraak citations via LIDO",
    "version": "1.0.13",
    "project_urls": {
        "Bug Tracker": "https://github.com/maastrichtlawtech/extraction_libraries",
        "Build Source": "https://github.com/maastrichtlawtech/extraction_libraries"
    },
    "split_keywords": [
        "rechtspraak",
        "citations",
        "rechtspraak citations",
        "rs citations"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "df50cb27d85324bd4a823bd59eff2cf746bab14ea1f563e2f47017f8a068845d",
                "md5": "01818d218abb45562d077a135604f01d",
                "sha256": "f42ed6add79a27409f516115e4be4617d7b04cbfae8ca4bd8a58a51a3108954f"
            },
            "downloads": -1,
            "filename": "rechtspraak_citations_extractor-1.0.13.tar.gz",
            "has_sig": false,
            "md5_digest": "01818d218abb45562d077a135604f01d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6903,
            "upload_time": "2023-09-27T12:49:22",
            "upload_time_iso_8601": "2023-09-27T12:49:22.346920Z",
            "url": "https://files.pythonhosted.org/packages/df/50/cb27d85324bd4a823bd59eff2cf746bab14ea1f563e2f47017f8a068845d/rechtspraak_citations_extractor-1.0.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-27 12:49:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "maastrichtlawtech",
    "github_project": "extraction_libraries",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "rechtspraak-citations-extractor"
}
        
Elapsed time: 0.12986s