Skip to main content

Python Package for functions that will procrastinate on their outputs

Project description

Build Badge

Code Procrastinator

Code Procrastinator is a Python package that humanizes your code by giving it the ability to procrastinate—just like you! :D

Instead of executing tasks efficiently, it gets distracted, mindlessly browses the internet, or justifies its procrastination with excuses.

PyPI Link


Team Members

Bryant To Andrew Bao Jasmine Zhang Imran Ahmed


Installation

You can install Code Procrastinator from PyPI using pip: This package requires Python 3.7 or higher

pip install code-procrastinator

Contributing

Want to improve Code Procrastinator? Follow these steps to set up your development environment!

Clone Repository

git clone https://github.com/software-students-spring2025/3-python-package-jeff-bezos.git
cd 3-python-package-jeff-bezos

Create a Virtual Environment

pip install pipenv
pipenv shell

Building

We automatically upload our package to PyPi using twine.
Before merging anything, ensure your contributions pass the unit tests

Important: PyPI will not let you upload a duplicate version, make sure to increment your version in your pyproject.toml file before pushing any changes. (Ex: 0.1.6 -> 0.1.7)

pytest procrastinator.py

Procrastinate()

The procrastinate function simulates what a human might do when procrastinating—whether it's scrolling the web, making excuses, or delaying execution.

Usage

To use Code Procrastinator in your own Python projects, simply import and call the procrastinate function:

from code_procrastinator import procrastinate

# Make your program procrastinate for up to 10 seconds, with 3 random delays
procrastinate(10, 3)

Function Behavior

  • Randomly selects a number of unique delays between 0 and max_time.
  • After each delay, it executes a random procrastination action.
  • Available actions include:
    • Printing excuses for procrastination.
    • Opening a fun website for distraction.

Arguments

Argument Type Description
max_time int The maximum number of seconds for any delay. Must be greater than 0.
delay_count int The number of procrastination delays. Must be greater than 0.

Exceptions

  • ValueError: Raised if max_time or delay_count is less than or equal to 0.

Return Value

  • set: A set of unique delay times used during procrastination.

Example Usage

>>> procrastinate(10, 3)
Procrastinating...
Let's take an internet break! :D https://en.wikipedia.org/wiki/Special:Random
Procrastinating...
Wow, this 4-hour video essay looks interesting...
Procrastinating...
I'll do it tomorrow

excuse_wrapper()

The excuse_wrapper function will also procrasinate on providing correct output, will relay an excuse, and has a chance to completely fail on the task.

Usage

Import excuse_wrapper, and use it as a decorator for the original function

from code_procrastinator import excuse_wrapper
@procrastinator.excuse_wrapper
def add(x, y):
    return x + y
add(1, 2)

Example Usage

>>> add(1. 2)
Optimizing best possible answer
Processing... 25% done.
Still thinking... 50% done.
Someone just deleted my work... I need to start over again...
TBH... forget this I'll do it tomorrow.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

code_procrastinator-0.1.7.tar.gz (44.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

code_procrastinator-0.1.7-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

Details for the file code_procrastinator-0.1.7.tar.gz.

File metadata

  • Download URL: code_procrastinator-0.1.7.tar.gz
  • Upload date:
  • Size: 44.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for code_procrastinator-0.1.7.tar.gz
Algorithm Hash digest
SHA256 fcc74701fbcc04b6daa9db342235c54e44d07539617157fb4331f4e69f2d09f0
MD5 057d3fda37c7d5c45423457348172883
BLAKE2b-256 c2dc03e108e6fba413299e2d8494eab7bf8077870616d595f8332591f2c2497b

See more details on using hashes here.

File details

Details for the file code_procrastinator-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for code_procrastinator-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e97415b9a675074f79b8b5d887f072f050caa2c115360e7707cb2856eddbc87f
MD5 447c195d7e42d6f8a1e3b1d419afed85
BLAKE2b-256 c69fe3428c326f3db7e9fb697b2ac21e1e76f54214ac012a45f58adc54700ac3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page