Merge pull request #16 from avisionh/feature/dockerfile

Feature: Dockerfile

Author: avisionh

Dockerfile

@@ -4,12 +4,30 @@ FROM python:${PY_VER} AS sqlqeurygraph-py
 ## Add the wait script to the image
 ADD https://github.com/ufoscout/docker-compose-wait/releases/download/2.9.0/wait /wait
 
+# download pipenv so can create requirements.txt
+# for faster environment recreation
+# https://pythonspeed.com/articles/pipenv-docker/
+RUN pip install --upgrade pip \
+    && pip install poetry
+COPY poetry.lock ./tmp
+COPY pyproject.toml ./
+RUN poetry export -f requirements.txt -o requirements.txt
+
+# move relevant folders and files from local to container
+COPY ./example ./example
+COPY sqlquerygraph.py ./
+COPY exporter.py ./
+COPY extractor.py ./
+COPY writer.py ./
+COPY loader.py ./
+
 # install package for loader and give it executable rights
-RUN pip install py2neo \
+RUN pip install -r requirements.txt \
     && mkdir log \
     && mkdir data \
+    && mkdir neo4j \
+    && python sqlquerygraph.py -sd 'example/sql' -ed 'example/neo4j' -rd 'github_repos' 'analytics' 'reporting' \
     && chmod +x /wait
 
 # move relevant files so they can be executed
-COPY ./loader.py ./
 COPY ./neo4j/*.cypher ./data

README.md

@@ -23,7 +23,6 @@ To run the code in here, ensure your system meets the following requirements:
 - Python 3.8 or above; and
 - [Poetry](https://python-poetry.org/docs/) installed.
 - [`direnv`](https://direnv.net/) installed, including shell hooks;
-- [`.envrc`](https://github.com/avisionh/sqlquerygraph/blob/main/.envrc) allowed/trusted by `direnv` to use the environment variables - see [below](#set-up);
 
 <!--Note there may be some Python IDE-specific requirements around loading environment variables, which are not considered here. -->
 
@@ -41,9 +40,9 @@ poetry install
 pre-commit install
 ```
 
-To then extract the tables and their dependencies from the example SQL scripts in the `sql/` directory, run the following in your shell/terminal:
+To then extract the tables and their dependencies from the example SQL scripts in the `sql/` directory, run the below in your shell/terminal. It will generate `.csv` files of the tables and their dependencies. It will also generate `.cypher` files to enable you to import the data into neo4j, after you have added the `.csv` files to the database.
 ```shell script
-python sqlquerygraph.py -sd 'sql' -ed 'neo4j' -rd 'github_repos' 'analytics' 'reporting'
+python sqlquerygraph.py -sd 'sql' -ed 'neo4j' -rd '<datasets, individually quoted and separated by commas, of tables in sql/ scripts>'
 ```
 
 ### Run neo4j graph database
@@ -59,19 +58,16 @@ We use [neo4j](https://neo4j.com/) for this project to visualise the dependencie
    export NEO4J_USERNAME=neo4j
    export NEO4J_PASSWORD=<your_password>
    ```
-
-1. Update your `.env` file to take in the new `.secrets` file you created by entering the below in your shell/terminal:
+   Then update your `.env` file to take in the new `.secrets` file you created by entering the below in your shell/terminal:
    ```shell script
    direnv allow
    ```
 
 1. Build the Docker image and launch the container. Within this directory that has the `docker-compose.yml` file, run the below in your shell/terminal:
    ```shell script
-   docker-compose build
    docker-compose up
    ```
-
-1. If it's the first time you have downloaded the neo4j docker image, wait awhile (maybe 15 minutes, depends on your machine specs). If you have downloaded the neo4j docker image before (such as going through these instructions), then wait a few minutes. You will know when it's ready when you get the following message in your terminal:
+   You will know when it's ready when you get the following message in your terminal:
    ```
    app      | [INFO  wait] Host [neo4j:7687] is now available!
    app      | [INFO  wait] --------------------------------------------------------
@@ -81,7 +77,7 @@ We use [neo4j](https://neo4j.com/) for this project to visualise the dependencie
    Then launch neo4j locally via opening your web browser and entering the following web address:
     - http://localhost:7474/
 
-1. The username and password will those specified in your `.secrets` file.
+   The username and password will those specified in your `.secrets` file.
 
 1. When you have finished playing with your local neo4j instance, remember to stop it running by executing the below in your shell/terminal:
    ```shell script

docker-compose.yml

@@ -14,7 +14,7 @@ services:
       - 7474:7474 # web client
       - 7687:7687 # db default port
     volumes:
-      - ./neo4j:/var/lib/neo4j/import
+      - ./example/neo4j:/var/lib/neo4j/import
     environment:
       - NEO4j_dbms.security.auth_enabled='true'
       # install graph-data-science plugin
@@ -30,7 +30,7 @@ services:
       - neo4j_network
 
   app:
-    build: .
+    build: . # build from Dockerfile
     container_name: app
     env_file: .env
     environment:
@@ -42,8 +42,8 @@ services:
       - neo4j
     command: >
       sh -c "/wait \
-             && python -m loader --file 'data/query_constraints.cypher' \
-             && python -m loader --file 'data/query_nodes.cypher' \
-             && python -m loader --file 'data/query_relationships.cypher'"
+             && python -m loader --file 'example/neo4j/query_constraints.cypher' \
+             && python -m loader --file 'example/neo4j/query_nodes.cypher' \
+             && python -m loader --file 'example/neo4j/query_relationships.cypher'"
     networks:
       - neo4j_network