Metadata-Version: 2.4
Name: pagestack
Version: 0.1.0
Summary: Create an EPUB from a list of URLs to read on your favorite e-reader.
Author: Arpit
License-Expression: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.31.0
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: lxml>=4.9.0
Requires-Dist: readability-lxml>=0.8.1
Requires-Dist: ebooklib>=0.18
Requires-Dist: Pillow>=10.0.0
Dynamic: license-file

PageStack
===

Create an EPUB from a list of URLs so you can read web content offline on your favorite e-reader. I built it to bundle my favorite engineering blogs into books I can load on my Kindle.

## Setup

### Install as a package

```bash
pip install pagestack
```

### Run from source

1. Clone the repository and navigate into it.
2. Install the dependencies:

```bash
pip install -r requirements.txt
```

## Usage

1. Create a text file, for example `urls.txt`, and add one URL per line.
2. Run the script (if installed):

```bash
pagestack examples/urls.txt uber-schemaless.epub \
    --title "Uber Schemaless - Blogs" \
    --author "Uber Engineering"
```

If you do not pass any parameter and just run by passing `urls.txt`, the
script assumes sane defaults and generates an epub file.

3. If you have installed it from source, then you can run the following

```bash
python src/pagestack/main.py examples/urls.txt uber-schemaless.epub \
    --title "Uber Schemaless - Blogs" \
    --author "Uber Engineering"
```

## Publishing on PyPi

```bash
pip install twine
twine upload dist/*
```

## License

MIT
