Brewing Package 🧪🔮

Welcome to the Brewing Package! This package is an educational resource with a Harry Potter theme, designed to teach organizing, documenting, and distributing code, as well as Continuous Integration (CI) practices.

Overview

The Brewing Package provides a magical experience for learning Python programming. Dive into the world of Hogwarts School of Witchcraft and Wizardry and explore the art of potion-making through code. Whether you're a beginner or an advanced wizard, this package offers something for everyone.

Features

Potion Brewing: Brew a variety of magical potions using Python classes and functions.
Ingredient Management: Access an extensive collection of magical ingredients and learn how to handle them in your potions.
Professor Snape's Inspection: Experience the thrill of Professor Snape's inspections as you ensure your potions meet his exacting standards.

Installation

To install the Brewing Package, follow these steps:

Clone the Repository: Clone the repository to your local machine using Git. Open your terminal and run the following command:
```
git clone https://github.com/[insert link here]
```
Navigate to the Repository: Change your current directory to the cloned repository by running:
```
cd brewing
```
Install the Package: Once you're inside the repository directory, install the package in editable mode using pip. This allows you to make changes to the code and have those changes reflected immediately:
```
pip install -e .
```

That's it! You've successfully installed the Brewing Package on your system. You can now start using it in your Python projects.

Getting Started

To get started, check out the documentation and examples provided in the package. Explore the different modules and classes to understand how to brew potions, manage ingredients, and handle inspections.

 my_name = 'ASPP student'
 my_potion = make_example_potion(student_name=my_name)
 # Let Snape inspect the potion
 inspection.inspection_by_Snape(potion=my_potion, target_potion='example_potion')

Contributing

We welcome contributions from fellow wizards and witches! Whether you have ideas for new potions, improvements to existing code, or bug fixes, feel free to contribute to the project. Check out our contribution guidelines for more information.

Credits

All credit for the package goes to Pamela Hathway

lschwetlick / 2024-ims-CI-project