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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: instapaper-scraper
-Version: 1.1.0rc1
+Version: 1.1.1
 Summary: A tool to scrape articles from Instapaper.
 Project-URL: Homepage, https://github.com/chriskyfung/InstapaperScraper
 Project-URL: Source, https://github.com/chriskyfung/InstapaperScraper
@@ -35,30 +35,54 @@ 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>
+  <a href="https://github.com/sponsors/chriskyfung" title="Sponsor on GitHub">
+    <img src="https://img.shields.io/badge/Sponsor-GitHub-blue?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?logo=buy-me-a-coffee&logoColor=ffdd00&colorA=263238" alt="Buy Me A Coffee">
+  </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.
+
+## ✨ Features
 
 - Scrapes all bookmarks from your Instapaper account.
 - Supports scraping from specific folders.
@@ -66,13 +90,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 +104,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 +119,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 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):
 
-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`:
 
@@ -152,7 +176,7 @@ output_filename = "python-articles.db"
 
 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 |
 | --- | --- |
@@ -164,7 +188,7 @@ When a `config.toml` file is present and no `--folder` argument is provided, the
 | `--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. |
 
-### Output Formats
+### 📄 Output Formats
 
 You can control the output format using the `--format` argument. The supported formats are:
 
@@ -176,7 +200,7 @@ 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>`.
 
@@ -188,7 +212,7 @@ instapaper-scraper --add-instapaper-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,9 +221,9 @@ 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)
 
 ```csv
 "id","instapaper_url","title","url"
@@ -207,7 +231,7 @@ The tool is designed with a modular architecture for reliability and maintainabi
 "999002345","https://www.instapaper.com/read/999002345","Article 2","https://www.example.com/page-2/"
 ```
 
-### JSON (`output/bookmarks.json`) (with --add-instapaper-url)
+### 📄 JSON (`output/bookmarks.json`) (with --add-instapaper-url)
 
 ```json
 [
@@ -226,15 +250,33 @@ The tool is designed with a modular architecture for reliability and maintainabi
 ]
 ```
 
-### 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
 
-This project uses `pytest` for testing, `black` for code formatting, and `ruff` for linting.
+Contributions are welcome! Whether it's a bug fix, a new feature, or documentation improvements, please feel free to open a pull request.
 
-### Setup
+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.
+
+### 🔧 Setup
 
 To install the development dependencies:
 
@@ -242,7 +284,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,7 +298,7 @@ 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:
 
@@ -264,12 +312,12 @@ To check test coverage:
 pytest --cov=src/instapaper_scraper --cov-report=term-missing
 ```
 
-### Code Quality
+### ✨ Code Quality
 
-To format the code with `black`:
+To format the code with `ruff`:
 
 ```sh
-black .
+ruff format .
 ```
 
 To check for linting errors with `ruff`:
@@ -284,10 +332,29 @@ To automatically fix linting errors:
 ruff check . --fix
 ```
 
-## Disclaimer
+To run static type checking with `mypy`:
+
+```sh
+mypy src
+```
+
+To run license checks:
+
+```sh
+licensecheck --show-only-failing
+```
+
+
+## 📜 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).

{instapaper_scraper-1.1.0rc1 → instapaper_scraper-1.1.1}/README.md

@@ -1,18 +1,40 @@
 # 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>
+  <a href="https://github.com/sponsors/chriskyfung" title="Sponsor on GitHub">
+    <img src="https://img.shields.io/badge/Sponsor-GitHub-blue?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?logo=buy-me-a-coffee&logoColor=ffdd00&colorA=263238" alt="Buy Me A Coffee">
+  </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.
+
+## ✨ Features
 
 - Scrapes all bookmarks from your Instapaper account.
 - Supports scraping from specific folders.
@@ -20,13 +42,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:
 
@@ -34,7 +56,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:
 
@@ -49,35 +71,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 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):
 
-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`:
 
@@ -106,7 +128,7 @@ output_filename = "python-articles.db"
 
 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 |
 | --- | --- |
@@ -118,7 +140,7 @@ When a `config.toml` file is present and no `--folder` argument is provided, the
 | `--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. |
 
-### Output Formats
+### 📄 Output Formats
 
 You can control the output format using the `--format` argument. The supported formats are:
 
@@ -130,7 +152,7 @@ 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>`.
 
@@ -142,7 +164,7 @@ instapaper-scraper --add-instapaper-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.
 
@@ -151,9 +173,9 @@ 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)
 
 ```csv
 "id","instapaper_url","title","url"
@@ -161,7 +183,7 @@ The tool is designed with a modular architecture for reliability and maintainabi
 "999002345","https://www.instapaper.com/read/999002345","Article 2","https://www.example.com/page-2/"
 ```
 
-### JSON (`output/bookmarks.json`) (with --add-instapaper-url)
+### 📄 JSON (`output/bookmarks.json`) (with --add-instapaper-url)
 
 ```json
 [
@@ -180,15 +202,33 @@ The tool is designed with a modular architecture for reliability and maintainabi
 ]
 ```
 
-### 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
 
-This project uses `pytest` for testing, `black` for code formatting, and `ruff` for linting.
+Contributions are welcome! Whether it's a bug fix, a new feature, or documentation improvements, please feel free to open a pull request.
 
-### Setup
+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.
+
+### 🔧 Setup
 
 To install the development dependencies:
 
@@ -196,7 +236,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:
 
@@ -204,7 +250,7 @@ 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:
 
@@ -218,12 +264,12 @@ To check test coverage:
 pytest --cov=src/instapaper_scraper --cov-report=term-missing
 ```
 
-### Code Quality
+### ✨ Code Quality
 
-To format the code with `black`:
+To format the code with `ruff`:
 
 ```sh
-black .
+ruff format .
 ```
 
 To check for linting errors with `ruff`:
@@ -238,10 +284,29 @@ To automatically fix linting errors:
 ruff check . --fix
 ```
 
-## Disclaimer
+To run static type checking with `mypy`:
+
+```sh
+mypy src
+```
+
+To run license checks:
+
+```sh
+licensecheck --show-only-failing
+```
+
+
+## 📜 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).

{instapaper_scraper-1.1.0rc1 → instapaper_scraper-1.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "instapaper-scraper"
-version = "1.1.0rc1"
+version = "1.1.1"
 description = "A tool to scrape articles from Instapaper."
 readme = "README.md"
 requires-python = ">=3.9"
@@ -35,7 +35,7 @@ dependencies = [
     "soupsieve~=2.8",
     "typing_extensions~=4.15.0",
     "urllib3>=2.5,<2.7",
-    "tomli~=2.0.1; python_version < '3.11'",
+    "tomli~=2.0.1; python_version < '3.11'"
 ]
 
 [project.urls]
@@ -46,24 +46,40 @@ Issues = "https://github.com/chriskyfung/InstapaperScraper/issues"
 [project.scripts]
 instapaper-scraper = "instapaper_scraper.cli:main"
 
+[tool.licensecheck]
+license = "GPL-3.0"
+
 [tool.pytest.ini_options]
 pythonpath = "src"
 
-[tool.black]
-line-length = 88
-
 [tool.ruff]
 line-length = 88
 
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+disallow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+
 [project.optional-dependencies]
 dev = [
     "pytest",
     "pytest-cov",
-    "black",
     "ruff",
     "types-requests",
     "types-beautifulsoup4",
     "requests-mock",
     "build",
-    "twine"
+    "twine",
+    "mypy",
+    "pre-commit",
+    "licensecheck"
 ]