https://github.com/defra/ai-data-development-standards

https://github.com/defra/ai-data-development-standards

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/defra/ai-data-development-standards
• Owner: DEFRA
• Created: 2024-08-13T08:22:48.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T11:11:24.000Z (2 months ago)
• Last Synced: 2024-09-18T15:32:47.517Z (2 months ago)
• Size: 5.93 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AI Data Development Standards

This is a repository of standards and supporting guidance for all developers working within DEFRA using Python.

The purpose of the standards are to ensure that delivery supports the Architecture Vision set out by the programme and better enable developer agility and mobility through consistent patterns and practices.

The guidance provides developers with quick access to resources and processes to best support the standards and delivery.

## Contents

- [Python coding standards](python_coding_standards.md)

## Defra standards

The standards and guidance contained here is intended to be an Python context specific layer over Defra DDTS' wider development standards.

This guide assumes that Developers already understand and follow these [core standards](https://github.com/DEFRA/software-development-standards/).

## Viewing the guide

The guide is best viewed in GitHub pages at [https://defra.github.io/ai-data-development-standards](https://defra.github.io/ai-data-development-standards/)

## Updating the guide

This documentation is written in markdown and is built using [MkDocs](https://www.mkdocs.org) and the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.

Please follow the below installation instructions prior to working with this repository:

- [mkdocs.org](https://www.mkdocs.org)

- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)

## Commands

* `mkdocs new [dir-name]` - Create a new project.

* `mkdocs serve` - Start the live-reloading docs server.

* `mkdocs build` - Build the documentation site.

* `mkdocs -h` - Print help message and exit.

* `mkdocs gh-deploy` - Deploy the documentation to GitHub pages.

## Project layout

    mkdocs.yml    # The configuration file.

    docs/

        index.md  # The documentation homepage.

        ...       # Other markdown pages, images and other files.

## Licence

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

The following attribution statement MUST be cited in your products and applications when using this information.

> Contains public sector information licensed under the Open Government license v3

### About the licence

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.