instapaper-scraper 1.1.0rc1__tar.gz → 1.2.0__tar.gz

{instapaper_scraper-1.1.0rc1/src/instapaper_scraper.egg-info → instapaper_scraper-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: instapaper-scraper
-Version: 1.1.0rc1
+Version: 1.2.0
 Summary: A tool to scrape articles from Instapaper.
 Project-URL: Homepage, https://github.com/chriskyfung/InstapaperScraper
 Project-URL: Source, https://github.com/chriskyfung/InstapaperScraper
@@ -21,7 +21,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: beautifulsoup4~=4.14.2
-Requires-Dist: certifi~=2025.11.12
+Requires-Dist: certifi<2026.2.0,>=2025.11.12
 Requires-Dist: charset-normalizer~=3.4.3
 Requires-Dist: cryptography~=46.0.3
 Requires-Dist: guara~=0.0.14
@@ -35,30 +35,58 @@ Requires-Dist: tomli~=2.0.1; python_version < "3.11"
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: black; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: types-beautifulsoup4; extra == "dev"
 Requires-Dist: requests-mock; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: licensecheck; extra == "dev"
 Dynamic: license-file
 
 # Instapaper Scraper
 
-![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fchriskyfung%2FInstapaperScraper%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml)
-[![CI](https://github.com/chriskyfung/InstapaperScraper/actions/workflows/ci.yml/badge.svg)](https://github.com/chriskyfung/InstapaperScraper/actions/workflows/ci.yml)
-[![PyPI version](https://img.shields.io/pypi/v/instapaper-scraper.svg)](https://pypi.org/project/instapaper-scraper/)
-[![PyPI Downloads](https://static.pepy.tech/personalized-badge/instapaper-scraper?period=total&left_text=downloads)](https://pepy.tech/projects/instapaper-scraper)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![GitHub License](https://img.shields.io/github/license/chriskyfung/InstapaperScraper)
-](https://www.gnu.org/licenses/gpl-3.0.en.html)
-[![codecov](https://codecov.io/gh/chriskyfung/InstapaperScraper/graph/badge.svg)](https://codecov.io/gh/chriskyfung/InstapaperScraper)
-
-A Python tool to scrape all your saved Instapaper bookmarks and export them to various formats.
-
-## Features
+<!-- Badges -->
+<p align="center">
+  <a href="https://pypi.org/project/instapaper-scraper/">
+    <img src="https://img.shields.io/pypi/v/instapaper-scraper.svg" alt="PyPI version">
+  </a>
+  <a href="https://pepy.tech/projects/instapaper-scraper">
+    <img src="https://static.pepy.tech/personalized-badge/instapaper-scraper?period=total&left_text=downloads" alt="PyPI Downloads">
+  </a>
+  <a href="https://github.com/chriskyfung/InstapaperScraper">
+    <img src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fchriskyfung%2FInstapaperScraper%2Frefs%2Fheads%2Fmaster%2Fpyproject.toml" alt="Python Version from PEP 621 TOML">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fastral-sh%2Fruff%2Fmain%2Fassets%2Fbadge%2Fv2.json" alt="Ruff">
+  </a>
+  <a href="https://codecov.io/gh/chriskyfung/InstapaperScraper">
+    <img src="https://codecov.io/gh/chriskyfung/InstapaperScraper/graph/badge.svg" alt="Code Coverage">
+  </a>
+  <wbr />
+  <a href="https://github.com/chriskyfung/InstapaperScraper/actions/workflows/ci.yml">
+    <img src="https://github.com/chriskyfung/InstapaperScraper/actions/workflows/ci.yml/badge.svg" alt="CI Status">
+  </a>
+  <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">
+    <img src="https://img.shields.io/github/license/chriskyfung/InstapaperScraper" alt="GitHub License">
+  </a>
+</p>
+
+A powerful and reliable Python tool to automate the export of all your saved Instapaper bookmarks into various formats, giving you full ownership of your data.
+
+<!-- Sponsors -->
+<p align="center">
+  <a href="https://github.com/sponsors/chriskyfung" title="Sponsor on GitHub">
+    <img src="https://img.shields.io/badge/Sponsor-GitHub-blue?style=for-the-badge&logo=github-sponsors&colorA=263238&colorB=EC407A" alt="GitHub Sponsors Default">
+  </a>
+  <a href="https://www.buymeacoffee.com/chriskyfung" title="Support Coffee">
+    <img src="https://img.shields.io/badge/Support-Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=ffdd00&colorA=263238" alt="Buy Me A Coffee">
+  </a>
+</p>
+
+## ✨ Features
 
 - Scrapes all bookmarks from your Instapaper account.
 - Supports scraping from specific folders.
@@ -66,13 +94,13 @@ A Python tool to scrape all your saved Instapaper bookmarks and export them to v
 - Securely stores your session for future runs.
 - Modern, modular, and tested architecture.
 
-## Getting Started
+## 🚀 Getting Started
 
-### 1. Requirements
+### 📋 1. Requirements
 
 - Python 3.9+
 
-### 2. Installation
+### 📦 2. Installation
 
 This package is available on PyPI and can be installed with pip:
 
@@ -80,7 +108,7 @@ This package is available on PyPI and can be installed with pip:
 pip install instapaper-scraper
 ```
 
-### 3. Usage
+### 💻 3. Usage
 
 Run the tool from the command line, specifying your desired output format:
 
@@ -95,35 +123,35 @@ instapaper-scraper --format json
 instapaper-scraper --format sqlite --output my_articles.db
 ```
 
-## Configuration
+## ⚙️ Configuration
 
-### Authentication
+### 🔐 Authentication
 
 The script authenticates using one of the following methods, in order of priority:
 
-1.  **Command-line Arguments**: Provide your username and password directly when running the script:
+1. **Command-line Arguments**: Provide your username and password directly when running the script:
 
     ```sh
     instapaper-scraper --username your_username --password your_password
     ```
 
-2.  **Session Files (`.session_key`, `.instapaper_session`)**: The script attempts to load these files in the following order:
+2. **Session Files (`.session_key`, `.instapaper_session`)**: The script attempts to load these files in the following order:
     a.  Path specified by `--session-file` or `--key-file` arguments.
     b.  Files in the current working directory (e.g., `./.session_key`).
     c.  Files in the user's configuration directory (`~/.config/instapaper-scraper/`).
     After the first successful login, the script creates an encrypted `.instapaper_session` file and a `.session_key` file to reuse your session securely.
 
-3.  **Interactive Prompt**: If no other method is available, the script will prompt you for your username and password.
+3. **Interactive Prompt**: If no other method is available, the script will prompt you for your username and password.
 
 > **Note on Security:** Your session file (`.instapaper_session`) and the encryption key (`.session_key`) are stored with secure permissions (read/write for the owner only) to protect your credentials.
 
-### Folder Configuration
+### 📁 Folder and Field Configuration
 
-You can define and quickly access your Instapaper folders using a `config.toml` file. The scraper will look for this file in the following locations (in order of precedence):
+You can define and quickly access your Instapaper folders and set default output fields using a `config.toml` file. The scraper will look for this file in the following locations (in order of precedence):
 
-1.  The path specified by the `--config-path` argument.
-2.  `config.toml` in the current working directory.
-3.  `~/.config/instapaper-scraper/config.toml`
+1. The path specified by the `--config-path` argument.
+2. `config.toml` in the current working directory.
+3. `~/.config/instapaper-scraper/config.toml`
 
 Here is an example of `config.toml`:
 
@@ -131,6 +159,12 @@ Here is an example of `config.toml`:
 # Default output filename for non-folder mode
 output_filename = "home-articles.csv"
 
+# Optional fields to include in the output.
+# These can be overridden by command-line flags.
+[fields]
+read_url = false
+article_preview = false
+
 [[folders]]
 key = "ml"
 id = "1234567"
@@ -145,14 +179,18 @@ output_filename = "python-articles.db"
 ```
 
 - **output_filename (top-level)**: The default output filename to use when not in folder mode.
-- **key**: A short alias for the folder.
-- **id**: The folder ID from the Instapaper URL.
-- **slug**: The human-readable part of the folder URL.
-- **output_filename (folder-specific)**: A preset output filename for scraped articles from this specific folder.
+- **[fields]**: A section to control which optional data fields are included in the output.
+    -   `read_url`: Set to `true` to include the Instapaper read URL for each article.
+    -   `article_preview`: Set to `true` to include the article's text preview.
+- **[[folders]]**: Each `[[folders]]` block defines a specific folder.
+    -   **key**: A short alias for the folder.
+    -   **id**: The folder ID from the Instapaper URL.
+    -   **slug**: The human-readable part of the folder URL.
+    -   **output_filename (folder-specific)**: A preset output filename for scraped articles from this specific folder.
 
 When a `config.toml` file is present and no `--folder` argument is provided, the scraper will prompt you to select a folder. You can also specify a folder directly using the `--folder` argument with its key, ID, or slug. Use `--folder=none` to explicitly disable folder mode and scrape all articles.
 
-### Command-line Arguments
+### 💻 Command-line Arguments
 
 | Argument | Description |
 | --- | --- |
@@ -162,9 +200,10 @@ When a `config.toml` file is present and no `--folder` argument is provided, the
 | `--output <filename>` | Specify a custom output filename. The file extension will be automatically corrected to match the selected format. |
 | `--username <user>` | Your Instapaper account username. |
 | `--password <pass>` | Your Instapaper account password. |
-| `--add-instapaper-url` | Adds a `instapaper_url` column to the output, containing a full, clickable URL for each article. |
+| `--[no-]read-url` | Includes the Instapaper read URL. (Old flag `--add-instapaper-url` is deprecated but supported). Can be set in `config.toml`. Overrides config. |
+| `--[no-]article-preview` | Includes the article preview text. (Old flag `--add-article-preview` is deprecated but supported). Can be set in `config.toml`. Overrides config. |
 
-### Output Formats
+### 📄 Output Formats
 
 You can control the output format using the `--format` argument. The supported formats are:
 
@@ -176,19 +215,19 @@ If the `--format` flag is omitted, the script will default to `csv`.
 
 When using `--output <filename>`, the file extension is automatically corrected to match the chosen format. For example, `instapaper-scraper --format json --output my_articles.txt` will create `my_articles.json`.
 
-#### Opening Articles in Instapaper
+#### 📖 Opening Articles in Instapaper
 
 The output data includes a unique `id` for each article. You can use this ID to construct a URL to the article's reader view: `https://www.instapaper.com/read/<article_id>`.
 
-For convenience, you can use the `--add-instapaper-url` flag to have the script include a full, clickable URL in the output.
+For convenience, you can use the `--read-url` flag to have the script include a full, clickable URL in the output.
 
 ```sh
-instapaper-scraper --add-instapaper-url
+instapaper-scraper --read-url
 ```
 
 This adds a `instapaper_url` field to each article in the JSON output and a `instapaper_url` column in the CSV and SQLite outputs. The original `id` field is preserved.
 
-## How It Works
+## 🛠️ How It Works
 
 The tool is designed with a modular architecture for reliability and maintainability.
 
@@ -197,17 +236,17 @@ The tool is designed with a modular architecture for reliability and maintainabi
 3. **Data Collection**: All fetched articles are aggregated into a single list.
 4. **Export**: Finally, the collected data is written to a file in your chosen format (`.csv`, `.json`, or `.db`).
 
-## Example Output
+## 📊 Example Output
 
-### CSV (`output/bookmarks.csv`) (with --add-instapaper-url)
+### 📄 CSV (`output/bookmarks.csv`) (with --add-instapaper-url and --add-article-preview)
 
 ```csv
-"id","instapaper_url","title","url"
-"999901234","https://www.instapaper.com/read/999901234","Article 1","https://www.example.com/page-1/"
-"999002345","https://www.instapaper.com/read/999002345","Article 2","https://www.example.com/page-2/"
+"id","instapaper_url","title","url","article_preview"
+"999901234","https://www.instapaper.com/read/999901234","Article 1","https://www.example.com/page-1/","This is a preview of article 1."
+"999002345","https://www.instapaper.com/read/999002345","Article 2","https://www.example.com/page-2/","This is a preview of article 2."
 ```
 
-### JSON (`output/bookmarks.json`) (with --add-instapaper-url)
+### 📄 JSON (`output/bookmarks.json`) (with --add-instapaper-url and --add-article-preview)
 
 ```json
 [
@@ -215,26 +254,57 @@ The tool is designed with a modular architecture for reliability and maintainabi
         "id": "999901234",
         "title": "Article 1",
         "url": "https://www.example.com/page-1/",
-        "instapaper_url": "https://www.instapaper.com/read/999901234"
+        "instapaper_url": "https://www.instapaper.com/read/999901234",
+        "article_preview": "This is a preview of article 1."
     },
     {
         "id": "999002345",
         "title": "Article 2",
         "url": "https://www.example.com/page-2/",
-        "instapaper_url": "https://www.instapaper.com/read/999002345"
+        "instapaper_url": "https://www.instapaper.com/read/999002345",
+        "article_preview": "This is a preview of article 2."
     }
 ]
 ```
 
-### SQLite (`output/bookmarks.db`)
+### 🗄️ SQLite (`output/bookmarks.db`)
 
 A SQLite database file is created with an `articles` table. The table includes `id`, `title`, and `url` columns. If the `--add-instapaper-url` flag is used, a `instapaper_url` column is also included. This feature is fully backward-compatible and will automatically adapt to the user's installed SQLite version, using an efficient generated column on modern versions (3.31.0+) and a fallback for older versions.
 
-## Development & Testing
+## 🤗 Support and Community
+
+- **🐛 Bug Reports:** For any bugs or unexpected behavior, please [open an issue on GitHub](https://github.com/chriskyfung/InstapaperScraper/issues).
+- **💬 Questions & General Discussion:** For questions, feature requests, or general discussion, please use our [GitHub Discussions](https://github.com/chriskyfung/InstapaperScraper/discussions).
+
+## 🙏 Support the Project
+
+`Instapaper Scraper` is a free and open-source project that requires significant time and effort to maintain and improve. If you find this tool useful, please consider supporting its development. Your contribution helps ensure the project stays healthy, active, and continuously updated.
+
+- **[Sponsor on GitHub](https://github.com/sponsors/chriskyfung):** The best way to support the project with recurring monthly donations. Tiers with special rewards like priority support are available!
+- **[Buy Me a Coffee](https://www.buymeacoffee.com/chriskyfung):** Perfect for a one-time thank you.
+
+## 🤝 Contributing
+
+Contributions are welcome! Whether it's a bug fix, a new feature, or documentation improvements, please feel free to open a pull request.
+
+Please read the **[Contribution Guidelines](CONTRIBUTING.md)** before you start.
+
+## 🧑‍💻 Development & Testing
+
+This project uses `pytest` for testing, `ruff` for code formatting and linting, and `mypy` for static type checking. A `Makefile` is provided to simplify common development tasks.
+
+### 🚀 Using the Makefile
+
+The most common commands are:
+-   `make install`: Installs development dependencies.
+-   `make format`: Formats the entire codebase.
+-   `make check`: Runs the linter, type checker, and test suite.
+-   `make test`: Runs the test suite.
+-   `make build`: Builds the distributable packages.
 
-This project uses `pytest` for testing, `black` for code formatting, and `ruff` for linting.
+Run `make help` to see all available commands.
 
-### Setup
+### 🔧 Setup
 
 To install the development dependencies:
 
@@ -242,7 +312,13 @@ To install the development dependencies:
 pip install -e .[dev]
 ```
 
-### Running the Scraper
+To set up the pre-commit hooks:
+
+```sh
+pre-commit install
+```
+
+### ▶️ Running the Scraper
 
 To run the scraper directly without installing the package:
 
@@ -250,26 +326,28 @@ To run the scraper directly without installing the package:
 python -m src.instapaper_scraper.cli
 ```
 
-### Testing
+### ✅ Testing
 
-To run the tests, execute the following command from the project root:
+To run the tests, execute the following command from the project root (or use `make test`):
 
 ```sh
 pytest
 ```
 
-To check test coverage:
+To check test coverage (or use `make test-cov`):
 
 ```sh
 pytest --cov=src/instapaper_scraper --cov-report=term-missing
 ```
 
-### Code Quality
+### ✨ Code Quality
 
-To format the code with `black`:
+You can use the `Makefile` for convenience (e.g., `make format`, `make lint`).
+
+To format the code with `ruff`:
 
 ```sh
-black .
+ruff format .
 ```
 
 To check for linting errors with `ruff`:
@@ -278,16 +356,29 @@ To check for linting errors with `ruff`:
 ruff check .
 ```
 
-To automatically fix linting errors:
+To run static type checking with `mypy`:
 
 ```sh
-ruff check . --fix
+mypy src
 ```
 
-## Disclaimer
+To run license checks:
+
+```sh
+licensecheck --zero
+```
+
+
+## 📜 Disclaimer
 
 This script requires valid Instapaper credentials. Use it responsibly and in accordance with Instapaper’s Terms of Service.
 
-## License
+## 📄 License
+
+This project is licensed under the terms of the **GNU General Public License v3.0**. See the [LICENSE](LICENSE) file for the full license text.
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=chriskyfung/InstapaperScraper)](https://github.com/chriskyfung/InstapaperScraper/graphs/contributors)
 
-This project is licensed under the terms of the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for the full license text.
+Made with [contrib.rocks](https://contrib.rocks).