Skip to main content

Vinews is an open-source library which provides modules for searching and scraping news data from Vietnamese news websites.

Project description

VINEWS

An open-source library dedicated to searching and scraping Vietnamese news websites with the goal of providing tools and enhancing AI agents news searching capabilities.

Note: This library is still under active development. Expect bugs and incomplete features. Contributions are welcome and appreciated!

Disclaimer & Terms of Use ‼️

This library is provided for educational and research purposes only. You are solely responsible for how you use it. Before scraping any website, you must ensure that your actions comply with all applicable laws and the website’s own policies — including their Terms of Service and robots.txt directives. Many websites explicitly prohibit automated access. The authors and contributors are not responsible for any misuse or legal issues arising from the use of this tool. Always scrape ethically, respectfully, and within legal boundaries.

Responsible Scraping ‼️

Please be respectful of the websites you interact with. Always use appropriate rate limiting and avoid sending excessive requests. Scraping should never disrupt or degrade the performance of a website. Generating unreasonable traffic may not only lead to IP bans but could also violate legal or ethical standards. Respect the site's resources, policies, and the efforts of its creators.

Supported Websites

  • VnExpress
  • more coming soon...

Installation

pip install vinews

Quick Start

from vinews.modules.vnexpress.search import VinewsVnExpressSearch
import asyncio
import json

search_engine = VinewsVnExpressSearch()
query = "Bitcoin"
    
# Test synchronous search
results = search_engine.search(query=query, date_range="day", category="kinhdoanh", limit=5, advanced=True)
print(results)

homepage = search_engine.search_homepage()
print(homepage)    

def vinews_async():
    # Test asynchronous search
    async def async_test():
        async_results = await search_engine.async_search(query=query, date_range="day", category="kinhdoanh", limit=5, advanced=True)
        
        async_homepage = await search_engine.async_search_homepage()

        # Optional saving
        with open("tests/output/vnexpress_search.json", "w", encoding="utf-8") as f:
            json.dump(async_results.model_dump(), f, indent=2, ensure_ascii=False)
        
        with open("tests/output/vnexpress_homepage.json", "w", encoding="utf-8") as f:
            json.dump(async_homepage.model_dump(), f, indent=2, ensure_ascii=False)
    
    asyncio.run(async_test())

if __name__ == "__main__":
    vinews_async()

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vinews-0.1.0b2.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vinews-0.1.0b2-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file vinews-0.1.0b2.tar.gz.

File metadata

  • Download URL: vinews-0.1.0b2.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for vinews-0.1.0b2.tar.gz
Algorithm Hash digest
SHA256 6285e45d572f34ae83bdd6c59bdbdbe5fac3e0c3c2e7653ab62aecc4e90babf8
MD5 4a68044e64814d0483874d6539aaa77b
BLAKE2b-256 d63736081adf1759bfafea1e98043e41fa46c74e08478fe01874edfe6c786304

See more details on using hashes here.

File details

Details for the file vinews-0.1.0b2-py3-none-any.whl.

File metadata

  • Download URL: vinews-0.1.0b2-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for vinews-0.1.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 154a327ff87726584638be24e87e102f8d76c48c7aa3f93cddaab83941bf4961
MD5 c069dbda3fadf31ea17bd5ac378dcdab
BLAKE2b-256 ff3128f9fd5a5a27d3f0551d2ea3954e5bd01c1a488b3e83e60a56b05188c6b9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page