{ "info": { "author": "Malte Schwarzer", "author_email": "hello@openlegaldata.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3.5", "Topic :: Utilities" ], "description": "# OLDP: Open Legal Data Platform\n\n[![Build Status](https://travis-ci.org/openlegaldata/oldp.svg?branch=master)](https://travis-ci.org/openlegaldata/oldp)\n[![Coverage Status](https://coveralls.io/repos/github/openlegaldata/oldp/badge.svg?branch=master)](https://coveralls.io/github/openlegaldata/oldp?branch=master)\n[![Documentation Status](https://readthedocs.org/projects/oldp/badge/?version=latest)](https://oldp.readthedocs.io/en/latest/?badge=latest)\n[![PyPI version](https://badge.fury.io/py/oldp.svg)](https://badge.fury.io/py/oldp)\n\nOLDP is a web application, written in Python 3.5 and based on the [Django web framework](https://www.djangoproject.com/),\nIt is used for processing legal text and providing a REST-API and Elasticsearch-based search engine.\nOLDP is being develop by the non-profit initiative [Open Legal Data](https://openlegaldata.io/) with the goal\nof building an Open Data platform for legal documents (mainly court decisions and laws).\nThe platform makes legal information freely accessible for the general public and especially third-party apps.\n\nOur documentation is available [here](https://oldp.readthedocs.io/).\n\n## Demo\n\n[![Live demo](https://github.com/openlegaldata/oldp/raw/master/docs/_static/screenshot.sm.png)](https://github.com/openlegaldata/oldp/raw/master/docs/_static/screenshot.png)\n\nA live demo is available [here](https://de.openlegaldata.io/) (in German).\n\n## Features\n\n- **Cases**: Court decisions with meta data and content in HTML.\n- **Laws**: Full-text laws and regulations and their corresponding case-law.\n- **Courts**: Browse courts organized by states, jurisdiction and level of appeal from your country.\n- **Search**: A document search engine based on Elasticsearch/Haystack supporting most common search syntax and faceting.\n- **API**: Adding, updating, retrieving and deleting data through CRUD REST API based on [DRF](https://www.django-rest-framework.org/) including\n auto-generated API clients from Swagger.\n- **Themes**: Easily adjust the look and feel depending on your countries needs (see [German theme](https://github.com/openlegaldata/oldp-de)).\n\n## Installation guide\n\nBefore you can use OLDP, you\u2019ll need to get it installed.\nFor a more detailed guide on how to get started with OLDP have a look at:\n[Getting started](https://oldp.readthedocs.io/en/latest/getting-started.html)\n\n### Docker\n\nTo skip the whole installation procedure you can simply run OLDP as Docker container.\nJust `git clone` the repository first and then start everything with a `docker-compose up` from within the repository directory.\nA small tutorial on how to use OLDP with Docker can be found [here](https://oldp.readthedocs.io/en/latest/docker.html).\n\n### Dependencies\n\nBefore anything else you will need to install the application dependencies.\n\n- **Python 3.5** with pip (virtualenv or conda recommended)\n- **Node JS 8.12.x** with npm for building JS dependencies\n- **Database (MySQL, SQLite, ...):** All database engines that support\n [Django's DB API](https://docs.djangoproject.com/en/2.1/ref/databases/) should work. MySQL is recommended.\n- **Elasticsearch 5.4.x**: Our search engine backend. Other systems supported by [haystack](http://haystacksearch.org/)\n should also work.\n- **Redis 4.x**: Caching engine (optional)\n- **gcc** Required to compile some Python libs\n- **python-mysqldb, libmysqlclient-dev** if you choose MySQL as database\n- **gettext** for Django locales with msguniq\n- **pandoc** convert docbook to HTML (import GG)\n- **GDAL**: Geospatial libraries used by the haystack search module (see\n [here](https://docs.djangoproject.com/en/2.1/ref/contrib/gis/install/geolibs/)).\n\n```\n# Create virtualenv\nvirtualenv -p python3 env\nsource env/bin/activate\n\n# Clone repository to current directory\ngit clone https://github.com/openlegaldata/oldp.git .\n\n# Install dependencies\napt-get install -y $(cat apt-requirements.txt)\npip install -r requirements.txt\nnpm install\n```\n\nThe first time you run OLDP, you will need to initialize the database with its default blank values. If you want\nto run OLDP in production mode, you also need to prepare static files and localization.\n\n```\n# Prepare assets (JS, CSS, images, fonts, ...)\nnpm run-script build\n\n# Prepare database\n./manage.py migrate\n\n# Localization (German and English, needed for production)\n./manage.py compilemessages --l de --l en\n\n# Prepare static files (needed for production)\n./manage.py collectstatic --no-input\n\n```\n\n## Run\n\nRun the following command to start the web app at [http://localhost:8000/](http://localhost:8000/).\n\n```\n./manage.py runserver 8000\n```\n\n### Settings\n\nThe manage the app settings we rely on [django-configurations](https://django-configurations.readthedocs.io/en/stable/).\nPre-configured settings can be used by setting the `DJANGO_CONFIGURATION` environment variable to either `Prod`, `Dev` or `Test`.\nYou can as well override specific settings from `oldp/settings.py` with environment variables:\n\n| Variable name | Default value | Comment |\n| ------------- | ------------- | ------- |\n| `DJANGO_SETTINGS_MODULE` | `oldp.settings` | Tell Django which settings file you want to use (in Python path syntax). |\n| `DJANGO_CONFIGURATION` | `Prod` | Choice a predefined class of settings: `Dev`, `Prod` or `Test` |\n| `DATABASE_URL` | `mysql://oldp:oldp@127.0.0.1/oldp` | Path to database (usually mysql or sqlite) |\n| `DJANGO_SECRET_KEY` | `None` | Set this to a secret value in production mode |\n| `DJANGO_ELASTICSEARCH_URL` | `http://localhost:9200/` | Elasticsearch settings (scheme, host, port) |\n| `DJANGO_ELASTICSEARCH_INDEX` | `oldp` | Elasticsearch index name |\n| `DJANGO_DEBUG` | `True` | Enable to show debugging messages and errors |\n| `DJANGO_ADMINS` | `Admin,admin@openlegaldata.io` | Format: `Foo,foo@site.com;Bar,bar@site.com` |\n| `DJANGO_ALLOWED_HOSTS` | `None` | Format: `foo.com,bar.net` |\n| `DJANGO_LANGUAGES_DOMAINS` | | Format: `{'de.foo.com':'de','fr.foo.com':'fr'}` |\n| `DJANGO_DEFAULT_FROM_EMAIL` | `no-reply@openlegaldata.io` | Emails are sent from this address |\n| `DJANGO_EMAIL_HOST` | `localhost` | SMTP server |\n| `DJANGO_EMAIL_HOST_USER` | | SMTP user |\n| `DJANGO_EMAIL_HOST_PASSWORD` | | SMTP password |\n| `DJANGO_EMAIL_USE_TLS` | `False` | enable TLS |\n| `DJANGO_EMAIL_PORT` | `25` | SMTP port |\n| `DJANGO_FEEDBACK_EMAIL` | `feedback@openlegaldata.io` | Messages from feedback widget are sent to this address. |\n| `DJANGO_TIME_ZONE` | `UTC` | Time zone |\n| `DJANGO_TEST_WITH_ES` | `False` | Run tests that require Elasticsearch |\n| `DJANGO_TEST_WITH_WEB` | `False` | Run tests that require web access |\n| `DJANGO_LOG_FILE` | `oldp.log` | Name of log file (in logs directory) |\n| `DJANGO_DISABLE_CACHE` | `False` | Set to `True` to disable cache (Redis) |\n\n\n\n## Issues\n\nPlease use our [GitHub issues](https://github.com/openlegaldata/oldp/issues) to report bugs, request feature or simply\nleave some feedback.\n\n## Contact\n\nTo contact Open Legal Data Platform, see here:\n\nhttps://de.openlegaldata.io/contact/\n\n## License\n\nOLDP is licensed under the MIT License.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/openlegaldata/oldp", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "oldp", "package_url": "https://pypi.org/project/oldp/", "platform": "", "project_url": "https://pypi.org/project/oldp/", "project_urls": { "Homepage": "https://github.com/openlegaldata/oldp" }, "release_url": "https://pypi.org/project/oldp/0.8.0/", "requires_dist": null, "requires_python": "", "summary": "Open Legal Data Platform", "version": "0.8.0" }, "last_serial": 5003466, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "d16060e1180125db057a49980c878a4e", "sha256": "0dca55bbf9cac0e12e8a0e06880e0217a2cd51704a241e3488f86518ea42a419" }, "downloads": -1, "filename": "oldp-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d16060e1180125db057a49980c878a4e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 130550, "upload_time": "2018-09-16T11:31:03", "url": "https://files.pythonhosted.org/packages/c4/60/a54bf3530170a75451af159491575afb04035e66d59ad7bdce7a9b6235c5/oldp-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5c73c4cce8aeb2b93095d24d61c82b6c", "sha256": "5274b24bd121ffe62ef71d22d8960089e5277e05e83e55478b73283b7b447bb2" }, "downloads": -1, "filename": "oldp-0.0.1.tar.gz", "has_sig": false, "md5_digest": "5c73c4cce8aeb2b93095d24d61c82b6c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 79303, "upload_time": "2018-09-16T11:31:05", "url": "https://files.pythonhosted.org/packages/48/87/73decd539617fb2fdaa6f3ed1413897efaef7895e715fd1d961afb4c2ace/oldp-0.0.1.tar.gz" } ], "0.8.0": [ { "comment_text": "", "digests": { "md5": "8bb61fc8662f92ca343dddfe6406dd09", "sha256": "f509afe7219a80549164cab5326b94be3d7f9d1c1656d5cdd6767566af00580e" }, "downloads": -1, "filename": "oldp-0.8.0.tar.gz", "has_sig": false, "md5_digest": "8bb61fc8662f92ca343dddfe6406dd09", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 110419, "upload_time": "2019-03-29T14:03:40", "url": "https://files.pythonhosted.org/packages/d8/d6/1054271097921b6b16f3ee9432608f88c85619d24f5c2a7634919f801234/oldp-0.8.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8bb61fc8662f92ca343dddfe6406dd09", "sha256": "f509afe7219a80549164cab5326b94be3d7f9d1c1656d5cdd6767566af00580e" }, "downloads": -1, "filename": "oldp-0.8.0.tar.gz", "has_sig": false, "md5_digest": "8bb61fc8662f92ca343dddfe6406dd09", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 110419, "upload_time": "2019-03-29T14:03:40", "url": "https://files.pythonhosted.org/packages/d8/d6/1054271097921b6b16f3ee9432608f88c85619d24f5c2a7634919f801234/oldp-0.8.0.tar.gz" } ] }