diff --git a/404.html b/404.html index 8e247f3..65f92e8 100644 --- a/404.html +++ b/404.html @@ -239,6 +239,34 @@ + + + + + +
  • + + Installation + +
    • + + + + + + + + + +
  • + + Usage + +
    • + + + + @@ -294,8 +322,6 @@ - - diff --git a/documentation/installation.html b/documentation/installation.html new file mode 100644 index 0000000..a5b79e5 --- /dev/null +++ b/documentation/installation.html @@ -0,0 +1,471 @@ + + + + + + + + + + + + + + + + + Installation - The Street Group Technical Test + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + +

    Installation

    +

    The task is written in Python 3.7.9 using Apache Beam 2.32.0. Python versions 3.6.14 and 3.8.11 should also be compatible but have not been tested.

    +

    The task has been tested on MacOS Big Sur and WSL2. The task should run on Windows but this wasn't tested.

    +

    For Beam 2.32.0 the supported versions of the Python SDK can be found here.

    +

    Poetry

    +

    The test uses Poetry for dependency management.

    +
    +

    Info

    +

    If you already have Poetry installed globally you can go straight to the poetry install step.

    +
    +

    In a virtual environment install poetry:

    +
    pip install poetry
+
    +

    From the root of the repo install the dependencies with:

    +
    poetry install --nodev
+
    + + + + + + + +
    +
    +
    + +
    + + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/usage.html b/documentation/usage.html new file mode 100644 index 0000000..0af3c3b --- /dev/null +++ b/documentation/usage.html @@ -0,0 +1,513 @@ + + + + + + + + + + + + + + + + + Usage - The Street Group Technical Test + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + +
    +
    +
    + + + +
    +
    +
    + + +
    +
    +
    + + +
    +
    + + + + + + + +

    Usage

    +

    This page documents how to run the pipeline locally to complete the task for the dataset for 2020.

    +

    The pipeline also runs in GCP using DataFlow and is discussed further on but can be viewed here. We also discuss how to adapt the pipeline so it can run against the full dataset.

    +

    Download dataset

    +

    The input data by default should go in ./data/input.

    +

    For convenience the data is available publicly in a GCP Cloud Storage bucket.

    +

    Run:

    +
    wget https://storage.googleapis.com/street-group-technical-test-dmot-euw1/input/pp-2020.csv -P data/input
+
    +

    to download the data for 2020 and place in the input directory above.

    +

    Entrypoint

    +

    The entrypoint to the pipeline is analyse-properties.

    +

    Available options

    +

    Running

    +
    analyse-properties --help
+
    +

    gives the following output:

    +
    usage: analyse-properties [-h] [--input INPUT] [--output OUTPUT]
+
+optional arguments:
+  -h, --help       show this help message and exit
+  --input INPUT    Full path to the input file.
+  --output OUTPUT  Full path to the output file without extension.
+
    +

    The default value for input is ./data/input/pp-2020.csv and the default value for output is ./data/output/pp-2020.

    +

    If passing in values for input/output these should be full paths to the files. The test will parse these inputs as a str() and pass this to beam.io.ReadFromText().

    +

    Run the pipeline

    +

    To run the pipeline and complete the task run:

    +
    analyse-properties --runner DirectRunner
+
    +

    The pipeline will use the 2020 dataset located in ./data/input and output the resulting .json to ./data/output.

    + + + + + + + +
    +
    +
    + +
    + + + + +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/img/successful_dataflow_job.png b/img/successful_dataflow_job.png new file mode 100644 index 0000000..b69548c Binary files /dev/null and b/img/successful_dataflow_job.png differ diff --git a/img/successful_dataflow_job.png:Zone.Identifier b/img/successful_dataflow_job.png:Zone.Identifier new file mode 100644 index 0000000..e69de29 diff --git a/index.html b/index.html index 8783d28..8d2fa40 100644 --- a/index.html +++ b/index.html @@ -286,6 +286,34 @@ + + + + + +
  • + + Installation + +
    • + + + + + + + + + +
  • + + Usage + +
    • + + + + @@ -344,6 +372,12 @@

    Welcome

    Introduction

    This documentation accompanies the technical test for the Street Group.

    +

    The following pages will guide the user through installing the requirements, and running the task to complete the test. In addition, there is some discussion around the approach, and any improvements that could be made.

    +

    Navigate the pages in order by using the section links in the left menu, or by using bar at the bottom of the page. The table of contents in the right menu can be used to navigate sections on each page.

    +
    +

    Note

    +

    All paths in this documentation, e.g ./analyse_properties/data/output refer to the location of the directory/file from the root of the repo.

    +
    @@ -360,6 +394,26 @@