Skip to content

ONSdigital/monthly-business-survey-results

Repository files navigation

monthly-business-survey-results

Statistical Methods Library for Python Pandas methods.

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.

To be added.

Requirements

Contributors have some additional requirements!

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

pip install -r requirements.txt

or for installing in development mode:

pip install .[dev]

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 .envrc.

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 monthly-business-survey-results, view our contributing guidelines.

Acknowledgements

This project structure is based on the govcookiecutter template project.