Skip to content
Back to search

oldp

Open Legal Data Platform

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/openlegaldata--oldp/badge.svg)](/listings/openlegaldata--oldp)

HTML

<a href="/listings/openlegaldata--oldp"><img src="/api/listings/openlegaldata--oldp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Before you can use OLDP, you’ll need to get it installed. For a more detailed guide on how to get started with OLDP have a look at: [Getting started](https://openlegaldata.github.io/oldp/main/getting-started.html)

Docker

To skip the whole installation procedure you can simply run OLDP as Docker (or Podman) container. Steps: 1. Clone the repository `git clone https://github.com/openlegaldata/oldp` 2. Rename the local [env file (`local.env`)](local.env) to `.env` 3. Run `make up`, which will either call the `docker` or `podman` container engine depending on your setup 4. Navigate to [localhost:8000](http://localhost:8000) to view the site

A small tutorial on how to use OLDP with Docker can be found [here](https://openlegaldata.github.io/oldp/main/docker.html).

Dependencies

Before anything else you will need to install the application dependencies.

- **Python 3.12** with pip (uv recommended) - **Database (MySQL, SQLite, ...):** All database engines that support [Django's DB API](https://docs.djangoproject.com/en/2.1/ref/databases/) should work. MySQL is recommended. - **Elasticsearch 7.17.x**: Our search engine backend. Other systems supported by [haystack](http://haystacksearch.org/) should also work. - **gcc** Required to compile some Python libs - **python-mysqldb, libmysqlclient-dev** if you choose MySQL as database - **gettext** for Django locales with msguniq - **pandoc** convert docbook to HTML (import GG) - **GDAL**: Geospatial libraries used by the haystack search module (see [here](https://docs.djangoproject.com/en/2.1/ref/contrib/gis/install/geolibs/)).

# Create virtualenv with uv
uv venv --python 3.12
source .venv/bin/activate

# Clone repository to current directory
git clone https://github.com/openlegaldata/oldp.git .

# Install dependencies
apt-get install -y $(cat apt_requirements.txt)
uv pip install -e ".[dev]"

The first time you run OLDP, you will need to initialize the database with its default blank values. If you want to run OLDP in production mode, you also need to prepare static files and localization.

# Prepare assets (JS, CSS, images, fonts, ...)
./manage.py compress

# Prepare database
./manage.py migrate

# Localization (German and English, needed for production)
./manage.py compilemessages --l de --l en

# Prepare static files (needed for production)
./manage.py collectstatic --no-input

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 149 lines
  1. # OLDP: Open Legal Data Platform
  2. > [!NOTE]
  3. > We're back! This project is getting a fresh update - join us on [Discord](https://discord.gg/WCy3aq25ZF) to help revive it.
  4. [![Documentation](https://img.shields.io/badge/docs-github--pages-blue)](https://openlegaldata.github.io/oldp/)
  5. [![PyPI version](https://badge.fury.io/py/oldp.svg)](https://badge.fury.io/py/oldp)
  6. OLDP is a Web application, written in Python 3.12 and based on the [Django web framework](https://www.djangoproject.com/),
  7. It is used for processing legal text and providing a REST-API and Elasticsearch-based search engine.
  8. OLDP is being develop by the non-profit initiative [Open Legal Data](https://openlegaldata.io/) with the goal
  9. of building an Open Data platform for legal documents (mainly court decisions and laws).
  10. The platform makes legal information freely accessible for the general public and especially third-party apps.
  11. Our documentation is available [here](https://openlegaldata.github.io/oldp/).
  12. ## Demo
  13. [![Live demo](https://github.com/openlegaldata/oldp/raw/main/docs/_static/screenshot.sm.png)](https://github.com/openlegaldata/oldp/raw/main/docs/_static/screenshot.png)
  14. A live demo is available [here](https://de.openlegaldata.io/) (in German).
  15. ## Features
  16. - **Cases**: Court decisions with meta data and content in HTML.
  17. - **Laws**: Full-text laws and regulations and their corresponding case-law.
  18. - **Courts**: Browse courts organized by states, jurisdiction and level of appeal from your country.
  19. - **Search**: A document search engine based on Elasticsearch/Haystack supporting most common search syntax and faceting.
  20. - **API**: Adding, updating, retrieving and deleting data through CRUD REST API based on [DRF](https://www.django-rest-framework.org/) including
  21. auto-generated API clients from Swagger.
  22. - **Themes**: Easily adjust the look and feel depending on your countries needs (see [German theme](https://github.com/openlegaldata/oldp-de)).
  23. ## Installation guide
  24. Before you can use OLDP, you’ll need to get it installed.
  25. For a more detailed guide on how to get started with OLDP have a look at:
  26. [Getting started](https://openlegaldata.github.io/oldp/main/getting-started.html)
  27. ### Docker
  28. To skip the whole installation procedure you can simply run OLDP as Docker (or Podman) container.
  29. Steps:
  30. 1. Clone the repository `git clone https://github.com/openlegaldata/oldp`
  31. 2. Rename the local [env file (`local.env`)](local.env) to `.env`
  32. 3. Run `make up`, which will either call the `docker` or `podman` container engine depending on your setup
  33. 4. Navigate to [localhost:8000](http://localhost:8000) to view the site
  34. A small tutorial on how to use OLDP with Docker can be found [here](https://openlegaldata.github.io/oldp/main/docker.html).
  35. ### Dependencies
  36. Before anything else you will need to install the application dependencies.
  37. - **Python 3.12** with pip (uv recommended)
  38. - **Database (MySQL, SQLite, ...):** All database engines that support
  39. [Django's DB API](https://docs.djangoproject.com/en/2.1/ref/databases/) should work. MySQL is recommended.
  40. - **Elasticsearch 7.17.x**: Our search engine backend. Other systems supported by [haystack](http://haystacksearch.org/)
  41. should also work.
  42. - **gcc** Required to compile some Python libs
  43. - **python-mysqldb, libmysqlclient-dev** if you choose MySQL as database
  44. - **gettext** for Django locales with msguniq
  45. - **pandoc** convert docbook to HTML (import GG)
  46. - **GDAL**: Geospatial libraries used by the haystack search module (see
  47. [here](https://docs.djangoproject.com/en/2.1/ref/contrib/gis/install/geolibs/)).
  48. ```bash
  49. # Create virtualenv with uv
  50. uv venv --python 3.12
  51. source .venv/bin/activate
  52. # Clone repository to current directory
  53. git clone https://github.com/openlegaldata/oldp.git .
  54. # Install dependencies
  55. apt-get install -y $(cat apt_requirements.txt)
  56. uv pip install -e ".[dev]"
  57. ```
  58. The first time you run OLDP, you will need to initialize the database with its default blank values. If you want
  59. to run OLDP in production mode, you also need to prepare static files and localization.
  60. ```bash
  61. # Prepare assets (JS, CSS, images, fonts, ...)
  62. ./manage.py compress
  63. # Prepare database
  64. ./manage.py migrate
  65. # Localization (German and English, needed for production)
  66. ./manage.py compilemessages --l de --l en
  67. # Prepare static files (needed for production)
  68. ./manage.py collectstatic --no-input
  69. ```
  70. ## Run
  71. Run the following command to start the web app at [http://localhost:8000/](http://localhost:8000/).
  72. ```bash
  73. ./manage.py runserver 8000
  74. ```
  75. ### Settings
  76. To manage the app settings we rely on [django-configurations](https://django-configurations.readthedocs.io/en/stable/).
  77. Pre-configured settings can be used by setting the `DJANGO_CONFIGURATION` environment variable to either `ProdConfiguration`, `DevConfiguration` or `TestConfiguration`.
  78. You can also override specific settings from `src/oldp/settings.py` with environment variables (all prefixed with `DJANGO_`).
  79. See the [**Configuration reference**](https://openlegaldata.github.io/oldp/main/configuration.html)
  80. for the full list of environment variables (database, Elasticsearch, caching, email, MCP, logging, …).
  81. ## Issues
  82. Please use our [GitHub issues](https://github.com/openlegaldata/oldp/issues) to report bugs, request feature or simply
  83. leave some feedback.
  84. ## Contact
  85. To contact Open Legal Data Platform, see here:
  86. https://de.openlegaldata.io/contact/
  87. ## Citation
  88. Please cite the following [research paper](https://arxiv.org/abs/2005.13342), if you use our code or data:
  89. ```bibtex
  90. @inproceedings{10.1145/3383583.3398616,
  91. author = {Ostendorff, Malte and Blume, Till and Ostendorff, Saskia},
  92. title = {Towards an Open Platform for Legal Information},
  93. year = {2020},
  94. isbn = {9781450375856},
  95. publisher = {Association for Computing Machinery},
  96. address = {New York, NY, USA},
  97. url = {https://doi.org/10.1145/3383583.3398616},
  98. doi = {10.1145/3383583.3398616},
  99. booktitle = {Proceedings of the ACM/IEEE Joint Conference on Digital Libraries in 2020},
  100. pages = {385–388},
  101. numpages = {4},
  102. keywords = {open data, open source, legal information system, legal data},
  103. location = {Virtual Event, China},
  104. series = {JCDL '20}
  105. }
  106. ```
  107. ## License
  108. OLDP is licensed under the MIT License.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.