全て歌詞の所為です。 README

全て歌詞の所為です。とは

『全て歌詞の所為です。』とは「界隈曲」と呼ばれる音楽ジャンルに焦点を当てた界隈曲情報掲載サイトです。
以下のような機能があります。

• 界隈曲の情報の掲載機能
• 界隈曲の情報の閲覧機能
• 界隈曲の情報の検索機能
• 界隈曲の歌詞の作成機能(全て蛇の目の所為です。)
• 界隈曲の宣伝機能(すべかしDSP)
• 設定機能

セットアップ方法

1. 前提条件 gitコマンドとpythonコマンドが使えることが前提です。
Pythonは本番環境に合わせて3.12を使ってください（Pillowの要件により3.10以下ではライブラリをインストールできません）。
pythonコマンドが未定義の場合、python3等のコマンドを用いてください。

2. クローン

git clone https://github.com/izumin2000/subekashi.git --depth 1

3. カレントディレクトリの変更

cd subekashi

4. 仮想環境の作成（必要に応じて）

pythonのvenvを利用して仮想環境.envを作成します。

python -m venv .env

5. 仮想環境の起動（必要に応じて）

@REM Windows PowerShell用
.env/Scripts/activate.ps1;
@REM Windows CMD用
.env\Scripts\activate.bat

# Linux用
source .env/bin/activate

6. ライブラリのインストール

pip install -r requirements.txt

7. local_setting.pyの作成

@REM Windows用
copy config/local_settings_sample.py config/local_settings.py

# Linux用
cp config/local_settings_sample.py config/local_settings.py

※ cpコマンドを利用できない場合は、別のファイルをコピーするコマンドかエクスプローラーを利用してください。

8. シェルの起動

python manage.py shell

9. 鍵の生成
以下のpythonコードを実行して鍵を生成します。
鍵の値はコピーしてください。

from django.core.management.utils import get_random_secret_key
get_random_secret_key()
quit()

quit()実行時にエラーが出力されることがありますが、気にしなくて大丈夫です。

10. local_settings.pyの設定
config/local_settings.pyを開き、コピーした値をSECRET_KEYに代入します。

SECRET_KEY = "=*************************************************"

11. マイグレーション

python manage.py makemigrations
python manage.py migrate

12. データベースの初期値の設定
マイグレーションした直後はデータベースにデータが入っておらずエラーになる処理がある為、以下のコマンドを実行して初期値を追加します。

python manage.py loaddata data.json

初期値には全てあなたの所為です。の全曲と『12』・『15』・『17』のほか、開発用のサンプルデータが登録されています。
サンプルデータは「サンプル」から始まる名前の作者・曲・記事などで、曲のカテゴリやフラグ、別名の種別、編集履歴、お問い合わせ、宣伝、年表、記事など、モデルごとの様々なデータを含みます。
stats・word・ai・timeline・delete・youtubeコマンドを実行した後のデータも含むため、これらのコマンドを実行しなくても、統計・歌詞作成・プレラ・削除済みのURLなどの画面を確認できます。
月次統計は2026年11月分までです。最新の月まで反映するにはpython manage.py statsを実行してください。
APIキー（曲のAPIの登録・変更・削除用）のサンプルは、is_activeがfalseの無効なダミーのため使えません。使うときは管理サイトで発行してください。
編集者のIPアドレスはダミーのため、python manage.py ipでは復号できません。曲のURLのうち「sAmPlE」から始まる動画IDはダミーのため、サムネイルは表示されません。

13. 定数ファイルの作成（必要に応じて）
全て歌詞の所為です。では高頻度で変わる定数ファイルを.gitignore対象でsubekashi/constants/dynamicに保存しております。
必要に応じて以下のコマンドを実行して定数ファイルを生成してください。

python manage.py const

起動方法

1. 仮想環境の起動（venvを利用している場合）
仮想環境.envを起動します。

@REM Windows PowerShell用
.env/Scripts/activate.ps1;
@REM Windows CMD用
.env\Scripts\activate.bat

# Linux用
source .env/bin/activate

2. サーバー起動

python manage.py runserver

3. アクセス
http://subekashi.localhost:8000/ にアクセスとアプリの画面が表示されます。
エラーが発生した場合はissueで報告してください。

全て歌詞の所為です。APIについて

全て歌詞の所為です。上で登録された情報はRESTfulなAPIで提供しています。
APIは全てのオリジンから利用できます（Access-Control-Allow-Origin: *）。Cookie等の認証情報を付けたクロスオリジンリクエストには対応していません。
ただし、曲の登録・変更・削除（取得以外）のAPIは、管理者が発行したAPIキーが必要です。利用したい場合は開発者に問い合わせてください（詳しくは「Song API（登録・変更・削除）」を参照）。

Song API

エンドポイント: https://lyrics.imicomweb.com/api/song メソッド: GET, HEAD, OPTIONS（登録・変更・削除は「Song API（登録・変更・削除）」を参照） レート制限: 2リクエスト/秒

全て歌詞の所為です。に登録された曲の情報を取得できます。
ユーザーが削除した曲は含まれません（/api/song/{song_id}で取得した場合も404になります）。

クエリパラメータ

テキスト検索（部分一致、大文字小文字を区別しない）

• title: タイトルで検索（最大500文字）
• author: 作者名で検索（最大500文字）
• lyrics: 歌詞で検索（最大10000文字）
• url: URLで検索（最大500文字）
  • 自動的にURLが正規化されます（YouTubeの短縮、クエリパラメータの削除など）
• keyword: タイトル、作者、歌詞、URLを横断検索（最大500文字）
  • 自動的にURLが正規化されます

完全一致検索

• title_exact: タイトルで完全一致検索（最大500文字）
• author_exact: 作者名で完全一致検索（最大500文字）

数値範囲フィルタ（1以上の値のみ）

• view_gte: 視聴回数の下限（1以上の整数）
• view_lte: 視聴回数の上限（1以上の整数）
• like_gte: いいね数の下限（1以上の整数）
• like_lte: いいね数の上限（1以上の整数）

日時範囲フィルタ

• upload_time_gte: アップロード日時の下限（ISO 8601形式）
• upload_time_lte: アップロード日時の上限（ISO 8601形式）

真偽値フィルタ

• is_subeana: すべあな曲かどうか
• is_joke: ネタ曲かどうか
• is_draft: 下書きかどうか
• is_original: オリジナル模倣曲かどうか
• is_inst: インスト曲かどうか
• is_deleted: 動画が非公開/削除済みかどうか
• is_limited: すべかし内で限定公開かどうか
• is_special: スペシャルデザインの曲かどうか
• is_collab: 合作の曲（作者が2人以上の曲）かどうか
• is_lack: 不完全な曲（情報が欠けている曲）
  • True で不完全な曲のみ、False で不完全な曲を除外します（以前は False を指定しても絞り込まれませんでした）

特殊フィルタ

• imitate: 模倣元の曲のsong ID（整数）
• imitated: 被模倣の曲のsong ID（整数）
• guesser: 候補（タイトル・チャンネル・URLを検索、最大500文字）
• mediatypes: メディアタイプ（正規表現対応、最大100文字）

ページネーション

• page: ページ番号（デフォルト: 1、最小: 1）
• size: 1ページあたりの件数（デフォルト: 50、最小: 1）

ソート

• sort: ソート順を指定
  • 利用可能な値: id, -id, title, -title, author, -author, upload_time, -upload_time, view, -view, like, -like, post_time, -post_time, imitate_count, -imitate_count, imitated_count, -imitated_count, random
  • -を付けると降順、付けないと昇順
  • idは登録日時順（登録が古い順）、-idは登録が新しい順
  • imitate_countは模倣元の数（その曲が模倣している曲の数）、imitated_countは模倣曲の数（その曲を模倣している曲の数）の順。数が同じ曲は登録が新しい順
  • randomを指定するとランダムソート

注意事項

• YouTube関連のフィルタ（view, like, upload_time）やソートを使用する場合、mediatypesを指定しない限り、自動的にYouTube動画のみに絞り込まれます
• view関連のフィルタまたはソートを使用する場合、view >= 1 の曲のみが対象となります
• like関連のフィルタまたはソートを使用する場合、like >= 1 の曲のみが対象となります
• sort=upload_time / sort=-upload_time を使用する場合、upload_time が null の曲は結果から除外されます
• view、likeの値は1以上の整数のみ受け付けます。0以下の値を指定するとバリデーションエラーが発生します
• バリデーションエラーが発生した場合、400 Bad Requestと共にエラーメッセージが返されます

レスポンス形式

一覧取得時

{
  "count": 100,
  "page": 1,
  "size": 50,
  "max_page": 2,
  "result": [
    {
      "id": 1,
      "title": "タイトル",
      "authors": [
        {
          "id": 1,
          "name": "作者"
        },
        ...
      ],
      "url": [
        "https://youtu.be/VIDEO-00000",
        "https://youtu.be/VIDEO-00001"
      ],
      ...
    }
  ]
}

• count: 検索条件に一致する曲の総数
• page: 現在のページ番号
• size: 1ページあたりの件数
• max_page: 最大ページ数
• result: 曲のリスト

This is the beginning of the README. Read the rest at the original. Read the full README ↗