Skip to content

Opinions and Disclaimers

Opinions

uv is the tool to use for Python Environment Management

Other tools are available. I just think uv is pretty neat. It does everything I need it to do, and it does it well. As you will see in the dependency management workshop, there should be interoperability between tools.

You should be creating MKDocs sites for your projects

I think MKDocs is a great way to create documentation for your projects. It is easy to use, and it integrates well with GitHub Pages. You can easily adapt other NHS England Mkdocs sites to use as a template for your own. However, you need to have a public repository for GitHub Pages to work.

You should be creating utility packages for your non-business logic code

You should be packaging your code. If your pipeline is full of specific business logic or methods, you should look into what generic utility code you can extract into a package. This workshop will help you do that.

Disclaimers

This is a Python focused workshop

Sorry R users. In NHS England Data Science team, we are a Python dominant team, so this is the language I am targeting this workshop at.If you are a R user, and you want help make a equivalent R workshop, please get in touch.

This workshop was built fast using AI

I have used AI tools to help me build this workshop quickly. Its like having a very enthusiastic Junior Dev on a lot coffee.

I have worked hard to check through every line of content that the AI has created and gone through the steps of the workshop myself (as have the facilitators). But, we might have missed things and there might be inaccuracies.

If you run into problems or find any issues, please raise an issue on GitHub if you find any. This is an open-source workshop after all.

Using this workshop in anger on real platforms and projects might not be simple

We should be able to do this stuff on real projects and platforms. But, we know that real life is messy and it might not as simple to adopt these practices. Hopefully, you are able to take away principles and techniques from this workshop that will make it easier for you to do Gold RAP work.