UC OSPO logo UC OSPO Network Education

Lesson

Python Package Development Best Practices

This lesson covers best practices for building Python packages, focusing on scientific software. It explains how to structure packages, write tests, manage dependencies, and distribute packages via PyPI.

View External Lesson Browse This Pathway

Lesson metadata

Slug python-package-development-best-practices
Pathway Maintaining & Sustaining Software
Subtopic —
Skill Level Intermediate
OSS Role(s) Contributor, Maintainer
Resource Type tutorial
Time Required 11m
Author MolSSI Education Team
License https://creativecommons.org/licenses/by/4.0/
Keywords Python, packaging, best practices, dependencies, testing, PyPI
Language(s) en

Additional metadata

Audience Python Developers, Researchers, Software Engineers
Competency Required Intermediate knowledge of Python and package management
Creative Work Status Active
Date Created 2020-10-01
Date Modified 2023-03-10
Date Published 2020-11-01
Domain General Open Source
Identifier https://education.molssi.org/python-package-best-practices/
Is Part Of MolSSI Python Best Practices Series
Learning Objectives After this lesson, the learner should be able to: - Apply best practices for structuring Python packages for scientific software - Demonstrate how to write comprehensive tests and manage dependencies - Implement version control workflows for collaborative package development - Create clear documentation using tools like Read The Docs - Configure continuous integration for automated testing and deployment
Mentions PyPI, https://pypi.org, A repository for Python packages
Notes intermediate experience scripting in Python; lesson for how to make their scripts into a software package. Lesson built around best practices from MolSSI ( computational molecular science)
Ospo Relevance High
Prerequisite Notes python-packaging-for-beginners | r-packaging
Sorting Id 23
Teaches The student will be able to structure Python packages, write tests, manage dependencies, and publish scientific software packages on PyPI.
Topic Packaging, Python
Version 1.0.0

Building Better Research Software

Intermediate

CI/CD for Research Software with GitLab CI

Intermediate

Continuous Integration and Delivery with GitHub Actions

Intermediate

Effective Code Review

Intermediate

Finding Users for Your Project

Beginner

Intermediate Python Development

Intermediate