Metadata-Version: 2.4
Name: jampm
Version: 0.1.0
Summary: Print bundled Web Development Lab experiment source files (exp.show(1), exp.show('5a'), ...).
Project-URL: Homepage, https://pypi.org/project/jampm/
Author: jampm
License: MIT
Keywords: experiments,lab,source,viewer,web-development
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# jampm

Print bundled Web Development Lab experiment source files from a single
import. Call `exp.show(<number>)` (or a string key like `'5a'`) and every file
inside that experiment folder is printed to stdout, each prefixed with a
header showing its filename.

## Install

```
pip install jampm
```

## Quick start

```python
from jampm import exp

exp.show(1)       # prints every file inside Experiment-1
exp.show(2)       # Experiment-2: event.html, index.html, style.css
exp.show(3)       # Experiment-3: bootstrap.html
exp.show(4)       # Experiment-4: index.html, script.js, style.css
exp.show('5a')    # Experiment-5 / 5a: index.html, script.js, style.css
exp.show('5b')    # Experiment-5 / 5b
exp.show(6)       # Experiment-6: events.html, registration.html

exp.list()        # list available experiment keys
exp.files('5a')   # list file names inside a given experiment
```

## Output format

For every file, the output is:

```
==========================
===== <filename> =====
path: <relative path>
==========================
<file contents>
```

## Available experiments

| Key  | Files                                  |
|------|----------------------------------------|
| 1    | event.html                             |
| 2    | event.html, index.html, style.css      |
| 3    | bootstrap.html                         |
| 4    | index.html, script.js, style.css       |
| 5a   | index.html, script.js, style.css       |
| 5b   | index.html, script.js, style.css       |
| 6    | events.html, registration.html         |

## License

MIT
