construction survey results

Project for construction survey

Where this documentation refers to the root folder we mean where this README.md is
located.

Getting started

To start using this project, first make sure your system meets its requirements.

It's suggested that you install this pack and it's requirements within a virtual environment.

Installing the package (Python Only)

Whilst in the root folder, in the command prompt, you can install the package and it's dependencies using:

python -m pip install -U pip setuptools
pip install -e .

or use the make command:

make install

This installs an editable version of the package. Meaning, when you update the package code, you do not have to reinstall it for the changes to take effect. (This saves a lot of time when you test your code)

Remember to update the setup and requirement files inline with any changes to your package. The inital files contain the bare minimum to get you started.

Running the pipeline (Python only)

The entry point for the pipeline is stored within the package and called main.py. To run the pipeline, run the following code in the terminal (whilst in the root directory of the project).

python cons_results/main.py

Alternatively, most Python IDE's allow you to run the code directly from the IDE using a run button.

Required secrets and credentials

To run this project, you need a .secrets file with secrets/credentials as environmental variables. The secrets/credentials should have the following environment variable name(s):

Secret/credential	Environment variable name	Description
Secret 1	SECRET_VARIABLE_1	Plain English description of Secret 1.
Credential 1	CREDENTIAL_VARIABLE_1	Plain English description of Credential 1.

Once you've added, load these environment variables using .env.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.

Contributing

If you want to help us build, and improve construction_survey_results, view our contributing guidelines.

Requirements

Contributors have some additional requirements!

• Python 3.6.1+ installed
• a .secrets file with the required secrets and credentials
• load environment variables from .env

To install the contributing requirements, open your terminal and enter:

python -m pip install -U pip setuptools
pip install -e .[dev]
pre-commit install

or use the make command:

make install_dev

Acknowledgements

This project structure is based on the govcookiecutter template project.