prezダウンロード - prezソースコードのダウンロード

prez

その他のソースコード

OGC

ダウンロード

プレズ

Prez は、プロファイルによるコンテンツネゴシエーション標準に従ってナレッジグラフデータのプロファイルを提供する、データ構成可能な Linked Data API フレームワークです。

UIはどこにありますか？
Prez はデータのみを配信します (通常は RDF ですが、GeoJSON、XML などの場合もあります)。また、Prez がデータベース内で見つけることができるすべてのオブジェクトと述語のラベルを含む特別な形式の RDF を配信します。
Prez のラベルが付いた RDF を HTML やその他の派手なグラフィカルウィジェットとしてレンダリングできる UI が必要な場合は、Prez UI を参照してください。

コンテンツ

インストール
構成
ランニング
リダイレクトサービス
データの検証
接触
貢献する
ライセンス

インストール

コンピュータ上に Prez のコピーを取得するには、次のコマンドを実行します。

git clone https://github.com/RDFLib/prez

Prez は、Python のパッケージ化および依存関係ツールである Poetry を使用して開発されています。 Poetry は、Prez のすべての依存関係 (他の Python パッケージ) をプロジェクトのルートディレクトリにあるpyproject.tomlファイルに示します。

Python の依存関係をインストールするには、次のコマンドを実行します。

poetry install

注:詩はシステムにインストールされている必要があります。 Poetry がインストールされているかどうかを確認するには、 poetry --versionを実行します。特定の依存関係グループのインストールと管理に関するヒントについては、ドキュメントを確認してください。

エンドポイント

Prez は次のエンドポイントを提供します。

コアエンドポイント

終点	デフォルトのMT
/	テキスト/アノット+タートル
/docs	テキスト/html
/catalogs/{カタログID}	テキスト/アノット+タートル
/catalogs/{catalogId}/コレクション	テキスト/アノット+タートル
/catalogs/{catalogId}/collections/{recordsCollectionId}	テキスト/アノット+タートル
/catalogs/{catalogId}/collections/{recordsCollectionId}/items	テキスト/アノット+タートル
/catalogs/{catalogId}/collections/{recordsCollectionId}/items/{itemId}	テキスト/アノット+タートル
/パージ-tbox-キャッシュ	アプリケーション/json
/tboxキャッシュ	アプリケーション/json
/健康	アプリケーション/json
/プレフィックス	テキスト/アノット+タートル
/concept-hierarchy/{parent_curie}/narrowers	テキスト/アノット+タートル
/concept-hierarchy/{parent_curie}/top-concepts	テキスト/アノット+タートル
/cql	テキスト/アノット+タートル
/プロファイル	テキスト/アノット+タートル
/検索	テキスト/アノット+タートル
/profiles/{profile_curie}	テキスト/アノット+タートル
/物体	テキスト/アノット+タートル
/識別子/リダイレクト	該当なし
/identifier/curie/{iri}	テキスト/プレーン
/identifier/iri/{キュリー}	テキスト/無地

OGC 機能 API エンドポイント

OGC 機能 API エンドポイントは、ROOT /catalogs/{catalogId}/collections/{recordsCollectionId}/に基づいています。

終点	デフォルトのMT
{ROOT}/機能	アプリケーション/json
{ROOT}/機能/ドキュメント	テキスト/html
{ROOT}/機能/適合性	アプリケーション/json
{ROOT}/機能/コレクション	アプリケーション/json
{ROOT}/features/collections/{collectionId}	アプリケーション/json
{ROOT}/features/collections/{collectionId}/items	アプリケーション/地域+json
{ROOT}/features/collections/{collectionId}/items/{featureId}	アプリケーション/ジオ+jso

構成

次の環境変数を使用して Prez を構成できます。ほとんどの場合、必要なのは SPARQL_ENDPOINT 変数だけです。

これらは、python-dotenv 経由で読み取られる「.env」ファイルに設定できます。あるいは、Prez が実行されている環境に直接設定します。

SPARQL エンドポイント構成

sparql_endpoint : Prez の読み取り専用 SPARQL エンドポイント。デフォルトはNoneです。
sparql_username : RDF DB で必要な場合、Prez SPARQL エンドポイントのユーザー名。デフォルトはNoneです。
sparql_password : RDF DB で必要な場合、Prez SPARQL エンドポイントのパスワード。デフォルトはNoneです。
enable_sparql_endpoint : SPARQL エンドポイントを有効にするかどうか。つまり、prez がリモートリポジトリの SPARQL エンドポイント (通常はトリプルストア) を公開するかどうか。デフォルトはFalseです。注意: SPARQL エンドポイントは、有効にすると POST リクエストをサポートします。 Prez 自体はリモートリポジトリ (リモート Triplestore など) を更新しませんが、リモート SPARQL エンドポイントが有効になっている場合、ユーザーは SPARQL エンドポイントを使用してリモートリポジトリを更新できる可能性があります。

ネットワーク構成

protocol : Prez の配信に使用されるプロトコル。デフォルトは"http"です。
host : Prez のホストドメイン名。デフォルトは"localhost"です。
port : Prez にアクセスできるポート。デフォルトは8000です。

システムURI

system_uri : Prez システム全体の IRI。この値は、Prez によって提供されるランディングページの RDF ( "/" ) に表示されます。デフォルトはf"{protocol}://{host}:{port}"です。

ロギング構成

log_level : ログレベル。デフォルトは"INFO"です。
log_output : ロギングの出力先。デフォルトは"stdout"です。

Prez メタデータ

prez_title : Prez インスタンスのタイトル。デフォルトは"Prez"です。
prez_desc : Prez インスタンスの説明。デフォルトは、Prez Web フレームワーク API の説明です。
prez_version : Prez インスタンスのバージョン。デフォルトはNoneです。

キュリーセパレーター

curie_separator : CURIE で使用される区切り文字。デフォルトは":"です。この区切り文字は Prez によって生成されたリンクに表示され、さらに URL パスにも表示されます。

順序付けと述語の構成

order_lists_by_label : リストをラベルで並べるかどうか。デフォルトはTrueです。

ラベル述語

人間が判読できるラベルを付けて RDF を表示するために使用されます。

label_predicates : ラベルに使用される述語のリスト。デフォルトには次のものが含まれます。
- skos:prefLabel
- dcterms:title
- rdfs:label
- sdo:name

注釈付き ( +anot ) メディアタイプが使用される場合、Prez は、上記のプロパティのいずれかを持つすべてのURI のトリプルを初期応答に含めます。これらの注釈トリプルはキャッシュされます。注釈は、HTML ページなどの表示目的で使用されます。

説明述語

上記のラベル述語と同様です。

description_predicates : 説明に使用される述語のリスト。デフォルトには次のものが含まれます。
- skos:definition
- dcterms:description
- sdo:description

来歴述語

上記の来歴述語と同様です。

provenance_predicates : 来歴に使用される述語のリスト。デフォルトには次のものが含まれます。
- dcterms:provenance

その他の述語

さらに、アノテーションメカニズムを使用して、一般に、存在する特定のプロパティを返すことができます。

other_predicates : 他の述語のリスト。デフォルトには次のものが含まれます。
- sdo:color
- reg:status
- skos:narrower
- skos:broader

SPARQLリポジトリの構成

sparql_repo_type : SPARQL リポジトリのタイプ。デフォルトは"remote"です。オプションは、 "remote" 、 "pyoxigraph" 、および"oxrdflib"です。
sparql_timeout : SPARQL クエリのタイムアウト。デフォルトは30です。

連絡先

prez_contact : Prez の連絡先情報。デフォルトはNoneです。

プレフィックスの生成

disable_prefix_generation : プレフィックス生成を無効にするかどうか。大規模なデータリポジトリのプレフィックス生成を無効にすることをお勧めします。さらに、常にprez/reference_data/prefixes/ディレクトリにプレフィックスを指定することをお勧めします。デフォルトはFalseです。

言語と検索の構成

default_language : Prez のデフォルト言語。デフォルトは"en"です。
default_search_predicates : デフォルトの検索述語。デフォルトには次のものが含まれます。
- rdfs:label
- skos:prefLabel
- sdo:name
- dcterms:title

ローカル RDF ディレクトリ

Pyoxigraph リポジトリと組み合わせて使用されます。メモリデータグラフ内の Pyoxigraph にロードするディレクトリ (リポジトリルートから) を指定します。他の種類のリポジトリには使用されません。

local_rdf_dir : ローカル RDF ファイルのディレクトリ。デフォルトは"rdf"です。

エンドポイント構造

endpoint_structure : リンクの生成に使用されるエンドポイントのデフォルトの構造。デフォルトは("catalogs", "collections", "items")です。

システムエンドポイント

system_endpoints : システムエンドポイントのリスト。デフォルトには次のものが含まれます。
- ep:system/profile-listing
- ep:system/profile-object

リストと検索の構成

listing_count_limit : リストエンドポイントでカウントするアイテムの最大数。この制限を超えるカウントは「">N」として返されます。N は制限です。デフォルトは100です。
search_count_limit : 検索結果で返される項目の最大数。デフォルトは10です。

時間的構成

temporal_predicate : 時間プロパティに使用される述語。デフォルトはsdo:temporalです。

クエリテンプレートの設定

endpoint_to_template_query_filename : エンドポイントをクエリテンプレートファイル名にマッピングする辞書。デフォルトは空の辞書です。

ランニング

このセクションは Prez をローカルで開発するためのものです。 Prez を本番環境で実行する場合は、以下の実行オプションを参照してください。

開発サーバーを実行するには (コード変更時の自動リロードを使用):

poetry run python main.py

コンテナ内で実行する

Prez コンテナイメージは Github Action を使用して構築されており、ここから入手できます。

リポジトリ内の Dockerfile を使用して Docker イメージを構築することもできます。

画像のバリエーション

イメージ名はghcr.io/rdflib/prezです。

latestタグは、Prez の最新の安定リリースを指します。すべての最新の安定リリースには、メジャー、メジャー、マイナー、およびそれを指すメジャー、マイナー、パッチタグが付いています。

たとえば、git タグが 3.2.4 のリリースの場合、コンテナイメージには次のタグが含まれます。

3
3.2
3.2.4
latest

mainブランチへの新しいコミットにより、 devタグを持つローリング開発イメージが作成されます。開発ビルドには、major.minor.{patch+1}-dev.{commits-since-last-release}.{short-commit-sha} の形式のタグも含まれます。これはセマンティックバージョニングに準拠しており、オーケストレーションシステムによって認識され、自動リリースが実行されます。

たとえば、最新のリリースが 3.2.4 で、リリース以来 7 つの新しいコミットがあり、短いコミット SHA が fc82562 である場合、コンテナーイメージタグは次のようになります。

3.2.5-dev.7.fc82562

プルした Docker イメージを実行するには:

 docker run -p 8000:8000 
    -e SPARQL_ENDPOINT=<your_sparql_endpoint> 
    <your_image_id>

上記のコマンドは、指定された sparql エンドポイントに接続されたポート 8000 で Prez を実行している Docker コンテナを起動します。

テスト

Prez は、テストとテストカバレッジレポートに PyTest と Coverage を使用します。

利用可能なすべてのテストを実行するには:

poetry run pytest tests

カバレッジ分析に使用可能なすべてのテストを実行するには、次の手順を実行します。

poetry run coverage run -m pytest tests

カバレッジレポートを生成するには:

poetry run coverage report

リダイレクトサービス

Linked Data サーバーとして、Prez は/identifier/redirectでリダイレクトサービスを提供します。このサービスはクエリパラメーターiri受け入れ、値を持つfoaf:homepage述語のデータベース内のiri検索し、存在する場合はリダイレクト応答を返します。値。

この機能は、管理するドメイン名で独自の永続的な識別子を発行する機関にとって便利です。永続識別子からターゲット Web リソースへのマッピングは、バックエンド SPARQL ストアに保存されます。

これは、w3id.org などの永続的な識別子サービスの代替ソリューションです。場合によっては、このような永続識別子サービスと組み合わせて使用すると、Web サーバー構成 (NGINX、Apache HTTP など) でリダイレクトマッピングを提供する必要がなくなり、代わりに構成を RDF データとして定義できます。

データの検証

Prez がさまざまなサブシステム経由でデータを配信するには、データがいくつかの最小要件に準拠している必要があります。たとえば、SKOS ConceptSchemes が定義されていない状態では VocPrez を実行できません。

検証

上記のすべてのプロファイルは、RDF データが有効かどうかをテストするために使用できるバリデータを提供します。もしそうであれば、Prez はそれで問題ありません。

プロファイルのバリデーターはすべてプロファイル自体から入手でき (上記の仕様リンクを介して他のプロファイルリソースのリストに移動します)、また、何もダウンロードまたはインストールせずに使用できるRDFToolsオンラインツールにもロードされます。

http://rdftools.kurrawong.net/validate

VocPrez Compoundedおよび同様のバリデーターを探してください。「複合」ビットは、バリデーターがすべての VocPrez および継承された要件に対してデータを検証することを意味します。

接触

注: このオープンソースツールは、オーストラリアの小規模なナレッジグラフ会社である KurrawongAI、メルボルン大学の開発者、およびオープンソースの貢献者によって積極的に開発およびサポートされています。
問題にフラグを立てたり、質問を提起したりするには、Issue Tracker で問題を作成するか、以下の詳細を使用して開発者に連絡することができます。

主な開発者は次のとおりです。

クラウォンAI https://kurrawong.net

デビッド・ハブグッド[email protected]

ニコラス・カー[email protected]

エドモンド・チュク[email protected]

メルボルン大学- Prez UI 主にJamie Feiss [email protected]