WordPressへの投稿を自動化するパッケージ
Project description
O.A.S.I.S
~ Optimized Article Sorting Intelligent System ~
[ Website ] • [ GitHub ] [ Twitter ] • [ Official Blog ]
[!IMPORTANT] このリポジトリのリリースノートやREADME、コミットメッセージの9割近くはclaude.aiやChatGPT4を活用したAIRA, SourceSage, Gaiah, HarmonAI_IIで生成しています。
OASISは、MarkdownファイルからWordPress, Qiita, Note, Zennへの投稿を自動化するPythonパッケージです。
更新情報
- v0.7.0:
- Zennへのクロス投稿機能を追加しました(ZennAPI V2)。
- WordPressとNoteにおけるMermaid図のレンダリングに対応しました。
- 詳しくはリリースノートをご覧ください。
過去の更新情報はこちら
- v0.6.0:
- Zennへのクロス投稿機能を追加しました。
- WordPressとNoteにおけるMermaid図のレンダリングに対応しました。
- 詳しくはリリースノートをご覧ください。
- v0.5.0:
- リンクプレビュー生成機能にiframelyサポートを追加しました。(実験的機能)
- Note API v2では、HTMLを直接挿入することで、従来の方法よりも高速にコンテンツを投稿できるようになりました。
- 詳しくはリリースノートをご覧ください。
- v0.4.3: Noteへの投稿機能を大幅に改善しました。
- マークダウンのより多くの要素に対応しました。
- 詳しくはリリースノートをご覧ください。
- v0.4.0: Noteへのクロス投稿機能を追加しました。MarkdownファイルからNoteへの記事投稿を自動化し、複数のプラットフォームでコンテンツを簡単に共有できます。 詳しくはリリースノートをご覧ください。
- 過去のバージョン情報はこちら: Releases
デモ
https://github.com/user-attachments/assets/742c5822-04ec-4f9b-98fb-42fc3a101ab6
はじめに
OASISを使用すると、MarkdownファイルからWordPress, Qiita, Note, Zennへの投稿を効率的に行うことができます。LLMによる自動カテゴリ・タグ提案やサムネイル画像の自動アップロードなど、便利な機能が満載です。
インストール
pip install -U oasis-article
使用方法
コマンドラインから使用する場合:
oasis /path/to/your/folder
オプション
--qiita
: Qiitaにも投稿する--note
: Noteにも投稿する--wp
: WordPressにも投稿する--zenn
: Zennにも投稿する--wp-user
: WordPressのユーザー名--wp-pass
: WordPressのパスワード--wp-url
: WordPressのURL--qiita-token
: QiitaのAPIトークン--note-email
: Noteのメールアドレス--note-password
: Noteのパスワード--note-user-id
: NoteのユーザーID--note-publish
: Noteに公開投稿する(指定しない場合は下書き保存)--firefox-binary-path
: Firefox の実行ファイルへのパス--firefox-profile-path
: 使用する Firefox プロファイルへのパス--firefox-headless
: Firefoxのヘッドレスモード--zenn-output-path
: ZennAPI V2で記事ファイルを生成する出力フォルダ
例:
oasis example\article\roomba01 --qiita --note --wp --zenn --firefox-headless
oasis article_draft\21_Hunk --qiita --note --wp --zenn --firefox-headless
Pythonスクリプトから使用する場合:
from oasis import OASIS
oasis = OASIS()
result = oasis.process_folder("/path/to/your/folder", post_to_qiita=True, post_to_note=True, post_to_wp=True, post_to_zenn=True) # Qiita, Note, WordPress, Zennへの投稿も行う場合
print(result)
設定
環境変数を使用して設定を行います: .env.exampleを参考にしてください。
AUTH_USER
: WordPressのユーザー名AUTH_PASS
: WordPressのパスワードBASE_URL
: WordPressサイトのURLLLM_MODEL
: 使用するLLMモデル(デフォルト: "gemini/gemini-1.5-pro-latest")QIITA_TOKEN
: QiitaのAPIトークン(Qiitaへの投稿を行う場合に必要)NOTE_EMAIL
: Noteのアカウントに関連付けられたメールアドレスNOTE_PASSWORD
: NoteアカウントのパスワードNOTE_USER_ID
: NoteのユーザーIDFIREFOX_BINARY_PATH
: Firefox の実行ファイルへのパス (任意)FIREFOX_PROFILE_PATH
: 使用する Firefox プロファイルへのパス (任意)
サンプルスクリプト
example/script
フォルダには、OASISの様々な機能を試すためのサンプルスクリプトが用意されています。
demo_note_api.py
: Note API v1を使用してNoteに記事を投稿するサンプルスクリプトdemo_note_api_v2.py
: Note API v2を使用してNoteに記事を投稿するサンプルスクリプトdemo_qiita_api.py
: Qiita APIを使用してQiitaに記事を投稿するサンプルスクリプトdemo_url2card.py
: URLからWebサイトカードを生成するサンプルスクリプト
これらのスクリプトは、OASISの機能を理解し、実際に試してみるための良い出発点となります。
ZennAPI V2 について
ZennAPI V2 は、Zenn と GitHub の連携を活用して動作します。 --zenn-output-path
オプションで指定したフォルダに、Zenn の記事ファイル (.md) を生成します。 生成された記事ファイルを GitHub リポジトリにプッシュすると、Zenn 上で記事が公開されます。
コントリビューション
OASISの開発にご協力いただける方は、GitHubリポジトリにアクセスしてください。Issue報告、プルリクエストをお待ちしております。
ライセンス
このプロジェクトはMITライセンスの下で公開されています。
謝辞
OASISの開発にあたり、多大な貢献をしていただいた方々に感謝申し上げます。
- Note APIの開発は Mr-SuperInsane/NoteClient を参考にさせていただきました。
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for oasis_article-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43b1a2c5dce9a356fdd6279ec500a61cf311329cf5cc05b142e6a91241ad2653 |
|
MD5 | d9f464ba4b92240b7c5e12df7b2a34eb |
|
BLAKE2b-256 | 790043072cf1b868218ba36dd3bb20bbe6388e15a313cc718c7f8940a76a594f |