mooch 0.0.2

A collection of common python utilities.

Python Mooch

This Python package is a collection of useful Python code that is commonly used on all types of Python projects.

Table of Contents

• Features
• Install
• Usage
• Contributing
• License

📖 Features

Config File

Uses a TOML config file. Easily get/set configuration values. Automatically sets values to defaults if they're not currently saved in the configuration file.

Location

Provide a zip code to get city, state and lat, lon.

Requires

Throw an exception if the installed python version isn't new enough. Throw an exception if the desired operating system is incorrect.

Logging

Add automatic logging to methods that are run by using a decorator. Useful for logging function arguments, start of function and end of function.

🛠 Install

# PyPI
pip install mooch

or

uv add mooch

📌 Dependencies

Python 3.9 or greater

🎮 Usage

Config File

from mooch import Config
default_settings = {
    "settings": {
        "name": "MyName,
        "mood": "happy",
    },
}

config = Config("settings.toml", default_settings)

print(config["settings.mood"])
config["settings.mood"] = "angry"
print(config["settings.mood"])

Location

from mooch import Location
location = Location(62704).load()

assert location.city == "Springfield"
assert location.state == "Illinois"
assert location.state_abbreviation == "IL"
assert location.latitude == "39.7725"
assert location.longitude == "-89.6889"

Requires

Throws an Exception if the requirement isn't satisified.

from mooch import Require

Require.python_version("3.13")
Require.operating_system("Windows")

Logging Decorator

For adding 'BEGIN' and 'END' to log files whenever the decorated function runs. Also logs the values of the args passed in.

from mooch.logging.decorators import log_entry_exit

@log_entry_exit
def random_function(arg1, arg2){
    print(arg1)
    print(arg2)
}

🏆 Contributing

PRs accepted.

If editing the Readme, please conform to the standard-readme specification.

Bug Reports and Feature Requests

Please use the issue tracker to report any bugs or request new features.

Contributors

📃 License

MIT © Nick Stuer