Metadata-Version: 2.4
Name: fortune-teller2607555
Version: 0.1.0
Summary: A fun Python package that generates random fortunes with a date.
Author: Brian, Naz, Jibril, Polina
License: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# fortune_package
![CI Status](https://github.com/software-students-spring2025/3-python-package-parallax/actions/workflows/build.yaml/badge.svg)

## Description
A small Python package to make your day just a bit brighter while coding! Test your luck and explore the many fortunes we've included. If you're lucky (or unlucky), the fortune you receive might just come true.

## PyPI Link
[fortune-package](Insert PyPI link here)

## Installation & Setup

### Installing Dependencies & Setting Up a Virtual Environment
To install the required dependencies and set up a virtual environment, use:
```sh
pipenv install
pipenv shell
```

### Importing fortune_package
To use `fortune_package` in your code, import it as follows:
```python
from fortune_emoji.function_name import function_name
```

## Usage
Below is an example of how to use `fortune_package`:
```python
from fortune_emoji import get_fortune

fortune = get_fortune()
print(f"Your fortune: {fortune}")
```

For a complete example of all functions, check out `test.py`.

## Contribution Guidelines
We welcome contributions! If you'd like to contribute:
1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Ensure your changes integrate well with existing tests and add new tests if necessary.
4. Submit a pull request for review.

### Code Testing
Run tests before submitting your new code:

```sh
pipenv install --dev pytest
pipenv run python -m pytest tests/
```

## The Team
- [brian105](https://github.com/brian105)
- [Jibril1010](https://github.com/Jibril1010)
- [polinapianina](https://github.com/polinapianina)
- [naseem-student](https://github.com/naseem-student)

