Metadata-Version: 2.4
Name: date_formatter_spcm
Version: 0.0.3
Summary: A simple package to format dates easily
Author-email: Sara Czasak <sara.p.czasak.m@gmail.com>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# Date Formatter SPCM

A simple Python package to format current dates easily.

## Installation

You can install the package using pip:

```bash
pip install date_formatter_spcm
```

## Usage

Import the functions from the `date_formatter` package:

```python
from date_formatter import get_pretty_date, dd_mm_yyyy, mm_dd_yyyy, slash_dd_mm_yyyy, slash_mm_dd_yyyy

# Get the current date in 'Day, Month Date, Year' format
print(get_pretty_date())  # e.g., Monday, July 20, 2026

# Get the current date in 'DD-MM-YYYY' format
print(dd_mm_yyyy())       # e.g., 20-07-2026

# Get the current date in 'MM-DD-YYYY' format
print(mm_dd_yyyy())       # e.g., 07-20-2026

# Get the current date in 'DD/MM/YYYY' format
print(slash_dd_mm_yyyy()) # e.g., 20/07/2026

# Get the current date in 'MM/DD/YYYY' format
print(slash_mm_dd_yyyy()) # e.g., 07/20/2026
```

```python
from date_formatter import get_past_pretty_date, past_dd_mm_yyyy, past_slash_mm_dd_yyyy
# --- Past Date Functions ---
# Get the date from 5 days ago in 'Day, Month Date, Year' format
print(get_past_pretty_date(5))

# Get the date from 7 days ago in 'DD-MM-YYYY' format
print(past_dd_mm_yyyy(7))

# Get the date from 3 days ago in 'MM/DD/YYYY' format
print(past_slash_mm_dd_yyyy(3))
```

## Features

- **get_pretty_date()**: Returns the current date like "Monday, July 20, 2026".
- **dd_mm_yyyy()**: Returns the current date in "DD-MM-YYYY" format.
- **mm_dd_yyyy()**: Returns the current date in "MM-DD-YYYY" format.
- **slash_dd_mm_yyyy()**: Returns the current date in "DD/MM/YYYY" format.
- **slash_mm_dd_yyyy()**: Returns the current date in "MM/DD/YYYY" format.
- **get_past_pretty_date(n)**: Returns the date from *n* days ago in a pretty format.
- **past_dd_mm_yyyy(n)**: Returns the date from *n* days ago (DD-MM-YYYY).
- **past_mm_dd_yyyy(n)**: Returns the date from *n* days ago (MM-DD-YYYY).
- **past_slash_dd_mm_yyyy(n)**: Returns the date from *n* days ago (DD/MM/YYYY).
- **past_slash_mm_dd_yyyy(n)**: Returns the date from *n* days ago (MM/DD/YYYY).

## How it works
This package is a lightweight wrapper built on top of Python's built-in `datetime` module to provide human-readable shortcuts for common date formats.

## Author

**Sara Czasak** - [sara.p.czasak.m@gmail.com](mailto:sara.p.czasak.m@gmail.com)

## License

This project is licensed under the MIT License.
