aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetr Šmerkl <46304018+SveterCZE@users.noreply.github.com>2021-05-02 13:04:33 +0200
committerGitHub <noreply@github.com>2021-05-02 13:04:33 +0200
commit37de443eb41246e3e3c57ca87ba61e7bff76cbe6 (patch)
tree12dde6fd115706e601827165d075037cd4d18b0e
parent569ee26cab627411126fb20cba7f68fe8bb544e8 (diff)
downloadjustice-37de443eb41246e3e3c57ca87ba61e7bff76cbe6.tar.gz
Update README.md
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 14d48b2..6ded70d 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,14 @@
My first larger project, an application using Pyhon, Flask and SQLite to download open commercial register data from the Czech Ministry of Justice (justice.cz) and convert them into an sqlite3 database. The applicaton also contains a front-end component to search in the database by various properties. The main goal of the application is to provide users with more advanced search options compared to the official search at the Ministry of Justice website.
<h1>Installation:</h1>
+Download a zip file containing the whole repository and store it into a folder on your PC. You should preferably use a virtual environment.
+
+You will need the following packages:
+<ul>
+ <li>requests</li>
+ <li>send2trash</li>
+ <li>lxml</li>
+</ul>
<h1>Running the application:</h1>
Firstly, you need to download the open data from the Ministry of Justice and build the database. Run "python justice_build.py", which will download all the source files, create an SQLite database and parse the downloaded data into the database. Note that after the downloaded data are uncompressed, they are around 13 GB and the database file has around 3.6 GB. It takes approximately 1 hour to download the data and build the database.