Create an Open-Source Project in Python

Learn how to set up an open-source project in Python using tools that this course will introduce to you.

Introduction

• Create an open-source project in Python
• What you should know

1. Starting a Project with Poetry

• What is Poetry?
• Install Poetry
• Starting a project
• What is pyproject.toml?
• Adding dependencies
• Poetry lock and install
• Checkpoint: What you have so far

2. Power Up Your Tests

• What is pytest?
• Introduction to your project
• Writing simple tests
• Testing with multiple parameters
• Test if an exception is raised
• What is a fixture?
• Using fixture
• Skipping a test, with good reasons
• Checkpoint: What you have so far

3. Tidy Up Your Code

• What is PEP 8?
• What is Black?
• Formatting your code with Black
• What is a linter?
• Linting your code with Flake8
• Using pre-commit to clean up automatically
• Checkpoint: What you have so far

4. Standardize Testing Using tox

• What is tox?
• tox basic usage
• tox advance usage
• Checkpoint: What you have so far

5. Setting up a Workflow on GitHub Action

• What is GitHub Action?
• Setting up a workflow for testing
• Why do you need code coverage?
• Adding code coverage to workflow

Conclusion

• Open-source project with good practice