Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nhsdigital/nhs-api-oauth2-client

Python OAuth2 Client for NHS England API Authentication
https://github.com/nhsdigital/nhs-api-oauth2-client

Last synced: 10 months ago
JSON representation

Python OAuth2 Client for NHS England API Authentication

Awesome Lists containing this project

README 

          
# Repository Template



[![CI/CD Pull Request](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=repository-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=repository-template)



Start with an overview or a brief description of what the project is about and what it does. For example -



Welcome to our repository template designed to streamline your project setup! This robust template provides a reliable starting point for your new projects, covering an essential tech stack and encouraging best practices in documenting.



This repository template aims to foster a user-friendly development environment by ensuring that every included file is concise and adequately self-documented. By adhering to this standard, we can promote increased clarity and maintainability throughout your project's lifecycle. Bundled within this template are resources that pave the way for seamless repository creation. Our supported tech stack includes:



- Terraform

- Python

- Node.js



Make use of this repository template to expedite your project setup and enhance your productivity right from the get-go. Enjoy the advantage of having a well-structured, self-documented project that reduces overhead and increases focus on what truly matters - coding!



## Table of Contents



- [Repository Template](#repository-template)

  - [Table of Contents](#table-of-contents)

  - [Setup](#setup)

    - [Prerequisites](#prerequisites)

    - [Installation](#installation)

  - [Usage](#usage)

    - [Testing](#testing)

  - [Architecture](#architecture)

    - [Diagrams](#diagrams)

    - [Configuration](#configuration)

  - [Contributing](#contributing)

  - [Contacts](#contacts)

  - [Licence](#licence)



## Setup



By including preferably a one-liner or if necessary a set of clear CLI instructions we improve user experience. This should be a frictionless installation process that works on various operating systems (macOS, Linux, Windows WSL) and handles all the dependencies.



Clone the repository



```shell

git clone https://github.com/nhs-england-tools/repository-template.git

cd nhs-england-tools/repository-template

```



### Prerequisites



The following software packages or their equivalents are expected to be installed



- [GNU make](https://www.gnu.org/software/make/) **v3.82 or later: OS X users, take note below**

- [Docker](https://www.docker.com/)



Note that the version of GNU Make available by default on OS X is earlier than this.  You will need to upgrade it, or certain `make` tasks will fail.  On OS X, you will need [homebrew](https://brew.sh/) installed, then to install `make`, like so:



```shell

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

brew install make

```



You will then see instructions to fix your `$PATH` variable to make the newly installed version available.

If you are using [dotfiles](https://github.com/nhs-england-tools/dotfiles), this is all done for you.



### Installation



Install and configure toolchain dependencies



```shell

make config

```



If this repository is



```shell

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/org/repo/branch/install.sh)"

```



## Usage



After a successful installation, provide an informative example of how this project can be used. Additional code snippets, screenshots and demos work well in this space. You may also link to the other documentation resources, e.g. the [User Guide](./docs/user-guide.md) to demonstrate more use cases and to show more features.



### Testing



There are `make` tasks for you to configure to run your tests.  Run `make test` to see how they work.  You should be able to use the same entry points for local development as in your CI pipeline.



## Architecture



### Diagrams



The [C4 model](https://c4model.com/) is a simple and intuitive way to create software architecture diagrams that are clear, consistent, scalable and most importantly collaborative. This should result in documenting all the system interfaces, external dependencies and integration points.



![Repository Template](./docs/diagrams/Repository_Template_GitHub_Generic.png)



### Configuration



Most of the projects are built with customisability and extendability in mind. At a minimum, this can be achieved by implementing service level configuration options and settings. The intention of this section is to show how this can be used. If the system processes data, you could mention here for example how the input is prepared for testing - anonymised, synthetic or live data.



## Contributing



Describe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like



- Environment setup for contribution, i.e. `CONTRIBUTING.md`

- Coding standards, branching, linting, practices for development and testing

- Release process, versioning, changelog

- Backlog, board, roadmap, ways of working

- High-level requirements, guiding principles, decision records, etc.



## Contacts



Provide a way to contact the owners of this project. It can be a team, an individual or information on the means of getting in touch via active communication channels, e.g. opening a GitHub discussion, raising an issue, etc.



## Licence



> The [LICENCE.md](./LICENCE.md) file will need to be updated with the correct year and owner



Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.



Any HTML or Markdown documentation is [© Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms of the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).