open-news-api 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,44 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ### Added
11
+ - *(Nothing yet – this section tracks upcoming features for the next release)*
12
+
13
+ ---
14
+
15
+ ## [0.1.1] - 2026-06-18
16
+
17
+ ### Fixed
18
+ - Packaging metadata for PyPI release (no functional changes).
19
+
20
+ *The package name may vary due to some PyPI issue, so it is recomended to use correct package name provided in README*
21
+
22
+ ---
23
+
24
+ ## [0.1.0] - 2026-06-17
25
+
26
+ ### Added
27
+ - **Core Article Extraction**: Fetch and parse full-text articles from any news URL using a custom built pipeline.
28
+ - **Live News Feeds**: Access real-time headlines from 10+ countries and multiple categories (business, tech, sports, etc.).
29
+ - **Google News Search**: Search for specific topics and automatically decode obfuscated Google News URLs to get clean article links.
30
+ - **RSS Discovery & Fetching**: Automatically discover RSS/Atom feeds from a website URL and fetch full feed entries.
31
+ - **Batch Processing**: Process multiple URLs or feeds in bulk with efficient concurrency.
32
+ - **Simple Summarization**: Generate concise summaries of articles (supports multiple backends).
33
+ - **Smart Caching**: Built-in caching mechanism to reduce API calls and speed up repeated requests.
34
+ - **Python 3.8+ Support**: Compatible with Python 3.8, 3.9, 3.10, 3.11, and 3.12.
35
+
36
+ ---
37
+
38
+ ## [Unreleased] - Future Plans
39
+
40
+ - **No Plans Yet**: Please help / suggest features that could be plugged here.
41
+
42
+ ---
43
+
44
+ [0.1.1]: https://github.com/alphap365/open-news/releases/tag/v0.1.1
@@ -0,0 +1,132 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [alphap365@example.com](mailto:alphap365@example.com) (replace with your actual email address).
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126
+ at [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [Mozilla CoC]: https://github.com/mozilla/diversity
131
+ [FAQ]: https://www.contributor-covenant.org/faq
132
+ [translations]: https://www.contributor-covenant.org/translations
@@ -0,0 +1,108 @@
1
+ # Contributing to Open News
2
+
3
+ Thank you for your interest in contributing to `open-news`! This document outlines the process for reporting issues, suggesting improvements, and submitting code changes.
4
+
5
+ ## Table of Contents
6
+ - [Code of Conduct](#code-of-conduct)
7
+ - [How to Report Issues](#how-to-report-issues)
8
+ - [Suggesting Enhancements](#suggesting-enhancements)
9
+ - [Development Setup](#development-setup)
10
+ - [Coding Standards](#coding-standards)
11
+ - [Testing](#testing)
12
+ - [Submitting Pull Requests](#submitting-pull-requests)
13
+ - [Questions?](#questions)
14
+
15
+ ## Code of Conduct
16
+ We expect all contributors to be respectful and constructive. Harassment, hate speech, or any form of abuse will not be tolerated.
17
+
18
+ ## How to Report Issues
19
+ If you find a bug, please open a GitHub issue with the following:
20
+
21
+ - **Clear title** describing the problem.
22
+ - **Steps to reproduce** (include URLs, code snippets, and the exact command you ran).
23
+ - **Expected vs. actual behaviour**.
24
+ - **Environment** (Python version, OS, package versions from `pip list`).
25
+ - **Logs** (if any, with `DEBUG` logging enabled).
26
+
27
+ ## Suggesting Enhancements
28
+ We welcome ideas for new features or improvements. Before opening an issue, search existing issues to avoid duplicates.
29
+
30
+ In your suggestion, explain:
31
+ - What problem it solves.
32
+ - How you envision the API or behaviour.
33
+ - Any alternatives you’ve considered.
34
+
35
+ ## Development Setup
36
+ 1. **Fork the repository** and clone it locally.
37
+ 2. **Set up a virtual environment** (recommended):
38
+ ```bash
39
+ python -m venv venv
40
+ source venv/bin/activate # Linux/macOS
41
+ venv\Scripts\activate # Windows
42
+ ```
43
+ 3. **Install the package in editable mode with development dependencies**:
44
+ ```bash
45
+ pip install -e .[dev]
46
+ ```
47
+ The `[dev]` extra should include `pytest`, `mypy`, `black`, `ruff`, etc. (See example `pyproject.toml` below.)
48
+ 4. **Install NLTK data** (used by `newspaper4k`):
49
+ ```bash
50
+ python -m nltk.downloader punkt
51
+ ```
52
+
53
+ ## Coding Standards
54
+ - **Formatting**: Use [Black](https://black.readthedocs.io/) with the default settings.
55
+ - **Linting**: Use [Ruff](https://docs.astral.sh/ruff/) (or `flake8` + `pylint`).
56
+ - **Type hints**: All public functions must have type annotations. Run `mypy` to verify.
57
+ - **Docstrings**: Follow Google style or NumPy style; include parameters, returns, and exceptions.
58
+
59
+ **Example `pyproject.toml` snippet:**
60
+ ```toml
61
+ [project.optional-dependencies]
62
+ dev = ["pytest>=7.0", "mypy>=1.0", "black>=23.0", "ruff>=0.1.0"]
63
+
64
+ [tool.black]
65
+ line-length = 88
66
+
67
+ [tool.ruff]
68
+ select = ["E", "F", "W", "I"]
69
+ fixable = ["I"]
70
+ ```
71
+
72
+ ## Testing
73
+ - We use `pytest` for unit tests.
74
+ - **All new features must include tests**. Bug fixes should include a regression test.
75
+ - Mock external HTTP requests using `responses` or `pytest-httpx` to avoid hitting real URLs during tests.
76
+ - Run the test suite locally:
77
+ ```bash
78
+ pytest tests/
79
+ ```
80
+ - Ensure test coverage does not decrease. If possible, run:
81
+ ```bash
82
+ pytest --cov=open_news tests/
83
+ ```
84
+
85
+ ## Submitting Pull Requests
86
+ 1. **Create a new branch** from `main` with a descriptive name (`fix-google-date-parsing` or `add-timeout-option`).
87
+ 2. **Make your changes**, following the coding standards.
88
+ 3. **Add or update tests** and documentation (README, docstrings).
89
+ 4. **Run the test suite** and ensure it passes.
90
+ 5. **Push your branch** and open a Pull Request (PR) against the `main` branch.
91
+ 6. In the PR description, include:
92
+ - What the PR does.
93
+ - Any related issue numbers (e.g., "Fixes #42").
94
+ - Screenshots or logs if relevant.
95
+ 7. A maintainer will review your PR. Please be responsive to feedback.
96
+
97
+ ### PR Checklist
98
+ - [ ] Code is formatted with Black.
99
+ - [ ] Linter (Ruff) reports no errors.
100
+ - [ ] Type hints added and `mypy` passes.
101
+ - [ ] New tests are included and pass.
102
+ - [ ] Documentation updated (if applicable).
103
+ - [ ] PR targets `main` and has no merge conflicts.
104
+
105
+ ## Questions?
106
+ If you’re unsure about anything, feel free to open a Discussion or ask in an existing issue thread. We’re happy to help you get started!
107
+
108
+ **Thank you for helping make `open-news` better!** 🚀
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 open-news
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,8 @@
1
+ include README.md
2
+ include LICENSE
3
+ include requirements.txt
4
+ include CHANGELOG.md
5
+ include CODE_OF_CONDUCT.md
6
+ include CONTRIBUTING.md
7
+ recursive-exclude __pycache__ *
8
+ recursive-exclude *.pyc