| Name | blog-ai-tool JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | Useful ai tools for markdown blog posts, support ai seo, ai summary, ai translation, etc. Compatible with blog framework like Hexo, Hugo, etc. |
| upload_time | 2024-12-19 09:31:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Ryan Yang Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ai
blog
hexo
hugo
seo
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# đ¤ Blog AI tool
[](https://pypi.org/project/blog-ai-tool/) [](https://pypi.org/project/blog-ai-tool/) [](README-Zh.md) [](README.md)
đ Useful ai tools for blog framework like Hexo, Hugo, etc, as long as you manage your blog with markdown format. [įŽäŊä¸æ](README-Zh.md)
## ⨠Features
- đ¯ Generate seo content (title, **description**, keywords) for blog posts in markdown format
- đ Generate ai summary for blog posts
- đ Translate blog posts to multiple languages
- đ ī¸ Support blog framework like Hexo, Hugo, etc.
- đ Support multiple language
- đ§ Support multiple AI model like OpenAI, Qwen, Llama, etc. As long as the model provides openai-compatible API.
## đ ī¸ Installation
```bash
pip install blog-ai-tool
```
## đ Usage
### Command Line
```bash
# Using default config file
blog-ai-tool
# if the above command is not working, try to use this following command instead
python -m blog_ai_tool
# Using custom config file
blog-ai-tool --config my-config.toml
# Override specific settings
blog-ai-tool --directory content/posts --model gpt-4
```
Disclaimer: AI may destory your blog, please use git to **backup** your blog before use. Also, its not recommended to use this tool without **reviewing** the generated content. Always check the generated content before publishing. The best time to use this tool is right after you have written the blog post, before publishing.
### Python API
```python
from blog_ai_tool import HugoBlogProcessor, load_config
# Load configuration
config = load_config("blog-ai-tool.toml")
# Initialize processor
processor = HugoBlogProcessor(
api_key="your-api-key",
base_url="https://api.openai.com/v1",
model="gpt-4",
language="auto",
config=config
)
# Process a single file
processor.process_markdown("path/to/post.md")
```
## đ Configuration
Download the [example config file](blog-ai-tool.toml) and modify it to your needs. Put the config file in your blog root directory (the same level as as your blog config file), then run the command.
## đ¤ Development
We sincerely welcome any contributions to this project. Please feel free to submit your ideas and suggestions.
## đ License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "blog-ai-tool",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ai, blog, hexo, hugo, seo",
"author": null,
"author_email": "Ryan Yang <code@zair.top>",
"download_url": "https://files.pythonhosted.org/packages/f0/7e/e3d3da84f631c302aff9d8ffdd6868d28dc12a9fd0928cfb48cf583473d1/blog_ai_tool-0.1.2.tar.gz",
"platform": null,
"description": "# \ud83e\udd16 Blog AI tool\n[](https://pypi.org/project/blog-ai-tool/) [](https://pypi.org/project/blog-ai-tool/) [](README-Zh.md) [](README.md)\n\n\ud83c\udf1f Useful ai tools for blog framework like Hexo, Hugo, etc, as long as you manage your blog with markdown format. [\u7b80\u4f53\u4e2d\u6587](README-Zh.md)\n\n## \u2728 Features\n- \ud83c\udfaf Generate seo content (title, **description**, keywords) for blog posts in markdown format\n- \ud83d\udcdd Generate ai summary for blog posts\n- \ud83c\udf0d Translate blog posts to multiple languages\n- \ud83d\udee0\ufe0f Support blog framework like Hexo, Hugo, etc.\n- \ud83c\udf10 Support multiple language\n- \ud83e\udde0 Support multiple AI model like OpenAI, Qwen, Llama, etc. As long as the model provides openai-compatible API.\n\n## \ud83d\udee0\ufe0f Installation\n\n```bash\npip install blog-ai-tool\n```\n\n## \ud83d\ude80 Usage\n\n### Command Line\n\n```bash\n# Using default config file\nblog-ai-tool\n\n# if the above command is not working, try to use this following command instead\npython -m blog_ai_tool\n\n# Using custom config file\nblog-ai-tool --config my-config.toml\n\n# Override specific settings\nblog-ai-tool --directory content/posts --model gpt-4\n```\n\nDisclaimer: AI may destory your blog, please use git to **backup** your blog before use. Also, its not recommended to use this tool without **reviewing** the generated content. Always check the generated content before publishing. The best time to use this tool is right after you have written the blog post, before publishing.\n\n### Python API\n\n```python\nfrom blog_ai_tool import HugoBlogProcessor, load_config\n\n# Load configuration\nconfig = load_config(\"blog-ai-tool.toml\")\n\n# Initialize processor\nprocessor = HugoBlogProcessor(\n api_key=\"your-api-key\",\n base_url=\"https://api.openai.com/v1\",\n model=\"gpt-4\",\n language=\"auto\",\n config=config\n)\n\n# Process a single file\nprocessor.process_markdown(\"path/to/post.md\")\n```\n\n## \ud83d\udcda Configuration\n\nDownload the [example config file](blog-ai-tool.toml) and modify it to your needs. Put the config file in your blog root directory (the same level as as your blog config file), then run the command.\n\n## \ud83e\udd1d Development\n\nWe sincerely welcome any contributions to this project. Please feel free to submit your ideas and suggestions.\n\n## \ud83d\udcdd License\n\nMIT",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Ryan Yang Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Useful ai tools for markdown blog posts, support ai seo, ai summary, ai translation, etc. Compatible with blog framework like Hexo, Hugo, etc.",
"version": "0.1.2",
"project_urls": {
"homepage": "https://github.com/ryanng/blog-ai-tool",
"repository": "https://github.com/ryanng/blog-ai-tool"
},
"split_keywords": [
"ai",
" blog",
" hexo",
" hugo",
" seo"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4d6c10f330e65d1af29e1f645322a151ba4e2e9418d52b705460bb8e48cce22d",
"md5": "d522f5fba294b78d5b7dffbf8acd012a",
"sha256": "d6df27a7076f82e1eefbd780fba5d4ffed490c71f557919d5b41bf1a7410f5df"
},
"downloads": -1,
"filename": "blog_ai_tool-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d522f5fba294b78d5b7dffbf8acd012a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8864,
"upload_time": "2024-12-19T09:31:54",
"upload_time_iso_8601": "2024-12-19T09:31:54.330673Z",
"url": "https://files.pythonhosted.org/packages/4d/6c/10f330e65d1af29e1f645322a151ba4e2e9418d52b705460bb8e48cce22d/blog_ai_tool-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f07ee3d3da84f631c302aff9d8ffdd6868d28dc12a9fd0928cfb48cf583473d1",
"md5": "a8fd03c447a7ce940872bd74639abe83",
"sha256": "34d90dd8cb56b335a08d4a2d15ff563de8cfe12a45e6e1670e8aff78c90efb68"
},
"downloads": -1,
"filename": "blog_ai_tool-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "a8fd03c447a7ce940872bd74639abe83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21778,
"upload_time": "2024-12-19T09:31:56",
"upload_time_iso_8601": "2024-12-19T09:31:56.720375Z",
"url": "https://files.pythonhosted.org/packages/f0/7e/e3d3da84f631c302aff9d8ffdd6868d28dc12a9fd0928cfb48cf583473d1/blog_ai_tool-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 09:31:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ryanng",
"github_project": "blog-ai-tool",
"github_not_found": true,
"lcname": "blog-ai-tool"
}
