Metadata-Version: 2.4
Name: foml
Version: 0.2.3
Summary: A simple command-line study library for FOML code notebooks, exam papers, and theory PDFs.
Author: FOML Study Library contributors
License-Expression: MIT
Keywords: FOML,PCA,LDA,machine learning,study
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Education
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: pypdf>=5.0

# FOML Study Library (`foml`)

A small Python command-line library that bundles the supplied study material in four separate sections:

1. **Code Files**: LDA, TensorFlow, PCA, KNN, and K-means notebooks
2. **Calvin**: Calvin's notebook, kept separate
3. **FOML Paper**: three FOML exam-solution notebooks
4. **FOML Theory**: two PCA theory PDFs

## Install from PyPI

Once this project has been published to PyPI:

```bash
python -m pip install foml
```

## Run

```bash
foml
```

Or run it as a Python module:

```bash
python -m foml
```

The interactive menu keeps four sections separate. For each notebook or PDF, choose to display the **entire readable content in the terminal at once**, read it page by page, or open the original file in its normal application. Full-terminal mode does not ask you to press N for every page; use terminal scrollback to review the output. PDF text extraction uses `pypdf`.

## Build locally

```bash
python -m pip install --upgrade build twine
python -m build
python -m twine check dist/*
```

This project has not yet been uploaded to PyPI. The package name `foml` must be available in your PyPI account when publishing.
