Metadata-Version: 2.4
Name: aunties
Version: 0.1.0
Summary: A simple library for displaying AI and Cybersecurity practical source code
Author: Aunties Contributors
License-Expression: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# Aunties — Python Practical Code Library

Aunties is a simple, free Python library that provides source code for practical programs from two subjects:

- **Artificial Intelligence (AI)**
- **Cyber and Information Security (CIS)**

The library allows users to display the complete source code of a practical directly in the terminal using a simple Python function.

## Features

- Stores practical programs organized by subject.
- Displays source code using a simple keyword.
- Preserves indentation, blank lines, and code formatting.
- Supports adding new practicals without modifying the main function.
- Open-source and designed for students and learners.

## Installation

Install the library using pip:

```bash
pip install aunties
```

*Note: This command will work once the package has been published on PyPI. To install the project before publication, see the Development section.*

## Usage

Import the `show` function:

```python
from aunties import show
```

Display a practical by passing its keyword:

```python
show("caesar")
```

Display another practical:

```python
show("rsa")
```

The library prints the complete source code of the selected practical in the terminal.

## Available Practicals

Practical keywords are based on their filenames without the `.py` extension.

| Subject | Filename | Keyword |
|---|---|---|
| Cyber and Information Security | `caesar.py` | `caesar` |
| Cyber and Information Security | `rsa.py` | `rsa` |
| Artificial Intelligence | `bfs.py` | `bfs` |
| Artificial Intelligence | `minimax.py` | `minimax` |

The table shows examples. Actual availability depends on the practical files included in the installed version.

## Project Structure

```text
aunties/
├── pyproject.toml
├── README.md
└── src/
    └── aunties/
        ├── __init__.py
        ├── show.py
        └── codes/
            ├── ai/
            └── cis/
```

## Adding a New Practical

1. Open the appropriate subject folder inside `codes/`.
2. Create a Python file, such as `vigenere.py`.
3. Add the practical's source code to that file.
4. Use its filename as the keyword:

```python
show("vigenere")
```

No changes to `show.py` are required when adding a uniquely named practical.

## Development

To install the project locally in editable mode, clone or download the repository, navigate to its root directory, and run:

```bash
python -m pip install -e .
```

You can then import and test the library in your Python scripts.

## Important Note

Aunties displays source code as text. It does not execute the displayed practical or perform encryption, decryption, or AI operations automatically.

## Contributing

Contributions are welcome. You can help by adding practical programs, improving documentation, fixing bugs, or suggesting improvements.

## License

This project is intended to be open-source. The
