# kraken_schema_org
<definition>
## How to use
```
from kraken_schema_org import kraken_schema_org as k
```
## Most common methods
### Normalize record
Given a record, returns a fully normalized record
```
normalized_record = k.get_normalized_record(record)
```
## Class
### Get class / get schema
Returns schema.org schema for a given record_type
```
schema = k.get_class(record_type)
schema = k.get_schema(record_type)
```
### Get json schema
Returns json schema for a given record_type
```
json_schema = k.get_json_schema(record_type)
```
### Get summary keys (subset of most commonly used keys)
Returns the most commonly used keys for a given record_type
```
summary_keys = k.get_summary_keys(record_type)
```
### Get sample data
Returns sample record for a given record_type
```
sample_record = k.get_data(record_type)
```
## Property methods
### Get normalized key
```
normalized_key = k.get_key(key)
```
### Get all keys
```
keys = k.get_keys(record_type)
```
### Get json-ld type for a key
```
json_ld_type = k.key_get_jsonld_types(key)
```
### Get json type for a key
```
json_type = k.key_get_json_types(key)
```
### Get python type for a key
```
python_type = k.key_get_python_types(key)
```
### Get html type for a key
```
html_type = k.key_get_html_type(key)
```
### Normalize value for a key
```
normalized_value = k.get_normalized_value(key, value)
```
### Get localized key
```
localized_key = k.get_localized_key(key, 'EN-US')
```
### Convert key
Returns official key from given key (ex: last name -> familyName)
```
normalized_key = k.convert_key(key)
```
### Get key definition
```
defn = k.get_property_definition(key)
```
## Records
### Get record type
```
record_type = k.get_record_type(record)
```
### Get record id
```
record_id = k.get_record_id(record)
```
### Get record name
```
record_name = k.get_record_name(record)
```
### Get normalized record
```
normalized_record = k.get_normalized_record(record)
```
### Get summary record
```
summary_record = k.get_summary_record(record)
```
### Get localized record
```
localized_record = k.get_localized_record(record, 'EN-US')
```
## Legacy functions
FMethods provided to ensure backward compatibility. Avoid using
### Normalize @type
```
record_type = 'person'
normalized_type = k.normalize_type(record_type)
```
### Normalize key/attribute
```
key = 'givenname'
normalized_key = k.normalize_key(key)
```
### Normalize value or record
```
record = {"@type": "schema:WebPage", "schema:url": "https://www.test.com"}
normalized_record = k.normalize_record(record)
normalized_value = k.normalize_value(record_type: str, key: str, value: xx, strict: bool)
```
### Get keys/attributes for a given @type
```
record_type = 'person'
keys = k.get_keys(record_type)
```
### Get Datatypes for a given key
```
record_type = 'schema:Person'
key = 'schema:givenName'
datatypes = k.get_datatype(record_type, key)
```
### Normalize type
```
normalized_record_type = k.normalize_type(record_type)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/tactik8/krakenschemaorg",
"name": "kraken-schema-org",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tactik8",
"author_email": "info@tactik8.com",
"download_url": "https://files.pythonhosted.org/packages/62/3b/2cd341edea434ef9e2af472defc30d58923cd9e868a77a1d6890c291c7bf/kraken-schema-org-0.1.9.tar.gz",
"platform": null,
"description": "\n# kraken_schema_org\n<definition>\n\n\n## How to use\n\n```\nfrom kraken_schema_org import kraken_schema_org as k\n```\n\n## Most common methods\n\n### Normalize record\nGiven a record, returns a fully normalized record\n```\nnormalized_record = k.get_normalized_record(record)\n```\n\n## Class\n\n### Get class / get schema\nReturns schema.org schema for a given record_type\n```\nschema = k.get_class(record_type)\nschema = k.get_schema(record_type)\n```\n### Get json schema\nReturns json schema for a given record_type\n\n```\njson_schema = k.get_json_schema(record_type)\n```\n\n### Get summary keys (subset of most commonly used keys)\nReturns the most commonly used keys for a given record_type\n```\nsummary_keys = k.get_summary_keys(record_type)\n```\n\n### Get sample data\nReturns sample record for a given record_type\n\n```\nsample_record = k.get_data(record_type)\n```\n\n\n\n## Property methods\n\n### Get normalized key\n```\nnormalized_key = k.get_key(key)\n```\n\n### Get all keys\n```\nkeys = k.get_keys(record_type)\n```\n\n### Get json-ld type for a key\n```\njson_ld_type = k.key_get_jsonld_types(key)\n```\n\n### Get json type for a key\n```\njson_type = k.key_get_json_types(key)\n```\n### Get python type for a key\n```\npython_type = k.key_get_python_types(key)\n```\n\n### Get html type for a key\n```\nhtml_type = k.key_get_html_type(key)\n```\n\n\n### Normalize value for a key\n```\nnormalized_value = k.get_normalized_value(key, value)\n```\n\n### Get localized key\n```\nlocalized_key = k.get_localized_key(key, 'EN-US')\n```\n\n### Convert key\nReturns official key from given key (ex: last name -> familyName)\n```\nnormalized_key = k.convert_key(key)\n```\n\n### Get key definition\n```\ndefn = k.get_property_definition(key)\n```\n\n## Records\n\n### Get record type\n```\nrecord_type = k.get_record_type(record)\n```\n\n### Get record id\n```\nrecord_id = k.get_record_id(record)\n```\n\n### Get record name\n```\nrecord_name = k.get_record_name(record)\n```\n\n### Get normalized record\n```\nnormalized_record = k.get_normalized_record(record)\n```\n\n\n### Get summary record\n```\nsummary_record = k.get_summary_record(record)\n```\n### Get localized record\n```\nlocalized_record = k.get_localized_record(record, 'EN-US')\n```\n\n\n\n\n\n## Legacy functions\nFMethods provided to ensure backward compatibility. Avoid using\n### Normalize @type\n\n```\nrecord_type = 'person'\nnormalized_type = k.normalize_type(record_type)\n```\n\n### Normalize key/attribute\n\n```\nkey = 'givenname'\nnormalized_key = k.normalize_key(key)\n```\n\n### Normalize value or record\n\n```\nrecord = {\"@type\": \"schema:WebPage\", \"schema:url\": \"https://www.test.com\"}\nnormalized_record = k.normalize_record(record)\nnormalized_value = k.normalize_value(record_type: str, key: str, value: xx, strict: bool)\n\n```\n\n### Get keys/attributes for a given @type\n\n```\nrecord_type = 'person'\nkeys = k.get_keys(record_type)\n```\n\n### Get Datatypes for a given key\n\n```\nrecord_type = 'schema:Person'\nkey = 'schema:givenName'\ndatatypes = k.get_datatype(record_type, key)\n```\n\n\n\n### Normalize type\n\n```\nnormalized_record_type = k.normalize_type(record_type)\n\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "kraken-schema-org",
"version": "0.1.9",
"project_urls": {
"Homepage": "https://github.com/tactik8/krakenschemaorg"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce6eef205b08aff5a88bef469df67e4481d37965567ac9e8dbaf4edf32b65d51",
"md5": "d01eacc27269eeb0d82d6e0e39ea0466",
"sha256": "13c1eac86143944a3db1919d09547b4fb469fcdf7ee85fade32272d3dafbcf1b"
},
"downloads": -1,
"filename": "kraken_schema_org-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d01eacc27269eeb0d82d6e0e39ea0466",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 369672,
"upload_time": "2024-01-24T15:28:37",
"upload_time_iso_8601": "2024-01-24T15:28:37.260862Z",
"url": "https://files.pythonhosted.org/packages/ce/6e/ef205b08aff5a88bef469df67e4481d37965567ac9e8dbaf4edf32b65d51/kraken_schema_org-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "623b2cd341edea434ef9e2af472defc30d58923cd9e868a77a1d6890c291c7bf",
"md5": "0067e21c03737cd6158b7124228ef2a8",
"sha256": "c0627af7c95c45868c4adee22f7fcc3b54bafaa872911e371f9dfebc93c74d3f"
},
"downloads": -1,
"filename": "kraken-schema-org-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "0067e21c03737cd6158b7124228ef2a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 354131,
"upload_time": "2024-01-24T15:28:38",
"upload_time_iso_8601": "2024-01-24T15:28:38.991762Z",
"url": "https://files.pythonhosted.org/packages/62/3b/2cd341edea434ef9e2af472defc30d58923cd9e868a77a1d6890c291c7bf/kraken-schema-org-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-24 15:28:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tactik8",
"github_project": "krakenschemaorg",
"github_not_found": true,
"lcname": "kraken-schema-org"
}
JSON
