Skip to main content

A CLI and programmatic tool to analyze Markdown files for SEO using Huggingface API

Project description

hf_seo_analyzer

hf_seo_analyzer là công cụ CLI và thư viện Python giúp phân tích nội dung Markdown thông qua API và tạo báo cáo chi tiết về SEO.

Chức năng chính

  • Gửi nội dung Markdown đến API để phân tích.
  • Tạo báo cáo Markdown với các số liệu SEO cụ thể.
  • Hỗ trợ phân tích file đơn lẻ hoặc cả thư mục.

Cách sử dụng

1. Phân tích file đơn lẻ

Phân tích một file Markdown thông qua API:

python3.10 -m hf_seo_analyzer.cli test_markdown.md

2. Phân tích cả thư mục

Phân tích tất cả các file Markdown trong một thư mục:

python3.10 -m hf_seo_analyzer.cli md_examples --batch

3. Tùy chỉnh API và khóa

Bạn có thể cấu hình API endpointAPI key trong file config.yaml tại thư mục làm việc:

endpoint: "https://example-api.com/analyze"
api_key: "your_api_key"

Trong đó, thông tin endpointapi_key được cung cấp nếu bạn là học viên của khoá học Tạo website Docusaurus & Tối ưu SEO.


Báo cáo

Khi phân tích thành công, các báo cáo sẽ được lưu trong thư mục seo-report tại thư mục làm việc.
Ví dụ:

seo-report/
├── test_markdown_seo_report.md
├── md_example_seo_report.md

Yêu cầu hệ thống

  • Python >= 3.10
  • Các thư viện Python: requests, PyYAML, argparse

Cài đặt gói phụ thuộc từ requirements.txt:

pip install -r requirements.txt

Nội dung báo cáo mẫu

📝 SEO Analysis Report

Tệp: post_1.md

Thời Gian Tạo: 2024-11-16 12:03:48


🔍 Tóm Tắt

  • Độ Dài Tiêu Đề: 49 (Tốt)
  • Độ Dài Mô Tả: 157 (Tốt)
  • Mật Độ Từ Khoá: 0.74% (Ngoài khoảng)
  • Các Tiêu Đề Tìm Thấy: H2, H3
  • Các Tiêu Đề Thiếu: H4
  • Liên Kết Nội Bộ: 3
  • Liên Kết Bên Ngoài: 2
  • Chứa Nội Dung Đa Phương Tiện:

📋 Phân Tích Chi Tiết

Tiêu Đề

Chỉ Số Giá Trị
Độ Dài Tiêu Đề 49
Từ Khoá Trong Tiêu Đề
Trạng Thái Độ Dài Tốt

Mô Tả

Chỉ Số Giá Trị
Độ Dài Mô Tả 157
Trạng Thái Độ Dài Tốt

Đường dẫn url (slug)

Chỉ Số Giá Trị
Độ Dài Slug 41
Trạng Thái Độ Dài Tốt
Từ Khoá Trong URL

Mật Độ Từ Khoá

Chỉ Số Giá Trị
Số Từ 2566
Số Từ Khoá 19
Mật Độ Từ Khoá 0.7404520654715511
Trạng Thái Mật Độ Ngoài khoảng

Tiêu Đề

Chỉ Số Giá Trị
Tìm thấy trong các cấp tiêu đề: H2, H3
Thiếu trong các cấp tiêu đề: H4

Thuộc tính mô tả ảnh

Chỉ Số Giá Trị
Từ Khoá Trong thẻ alt

Liên Kết

Chỉ Số Giá Trị
Số Liên Kết Bên Ngoài 2
Số Liên Kết Nội Bộ 3
Liên Kết Bên Ngoài ![1982167386.01. SCLZZZZZZZ SX500, https://m.media-amazon.com/images/P/1982167386.01.SCLZZZZZZZ_SX500.jpg "Phương pháp PARA trong tổ chức thông tin hiệu quả 5", Amazon, https://amzn.to/3MGQoYn
Liên Kết Nội Bộ Hướng dẫn sử dụng Obsidian toàn tập, https://thinhvu.com/2023/01/29/huong-dan-su-dung-obsidian-toan-tap/, Phương pháp PARA - Tiago Forte, https://thinhvu.com/wp-content/uploads/2023/05/phuong-phap-para-summary-thinhvu.jpg "Phương pháp PARA trong tổ chức thông tin hiệu quả 3", Phương pháp PARA trong tổ chức thông tin hiệu quả, https://thinhvu.com/wp-content/uploads/2023/05/Obsidian-PARA-Zettelkasten-Journalit-thinhvu.jpg "Phương pháp PARA trong tổ chức thông tin hiệu quả 4"

Độ Dài Đoạn Văn

Chỉ Số Giá Trị
Độ Dài Đoạn Văn Trung Bình 59.674418604651166
Trạng Thái Độ Dài Tốt

Loại Từ Trong Tiêu Đề

Chỉ Số Giá Trị
Từ Tích Cực
Từ Tiêu Cực Không
Từ Mạnh Không

Điểm Số Từ

100


Từ Khoá Chính Duy Nhất

True


Chứa Nội Dung Đa Phương Tiện

True

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

hf_seo_analyzer-0.1.4.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

hf_seo_analyzer-0.1.4-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file hf_seo_analyzer-0.1.4.tar.gz.

File metadata

  • Download URL: hf_seo_analyzer-0.1.4.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.0

File hashes

Hashes for hf_seo_analyzer-0.1.4.tar.gz
Algorithm Hash digest
SHA256 2f6816fc9ee9d31fbdf520f8e57dab5c829d153e9d87bb9376de82cde53e3785
MD5 00bb27fbe8150273a44b73d066c18fbd
BLAKE2b-256 55eaff19d372f648d62c61b22ad69d9acbfa51bb472492c0df8bf9d8c8abfbb2

See more details on using hashes here.

File details

Details for the file hf_seo_analyzer-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for hf_seo_analyzer-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 697482408c8ee0408066f1851a341c1b5239dff6b5af02a77beec0c1b68f71e3
MD5 9398e9600adaa4354754a881db7fbdf3
BLAKE2b-256 02aa414a93341a67c098a3b677c58513958452c53e52ec46fe3b0595eb8c0c6f

See more details on using hashes here.

Supported by

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