schema-org-python 0.1.0__py3-none-any.whl

schema_models/article.py

@@ -0,0 +1,27 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.creative_work import CreativeWork
+from schema_models.speakable_specification import SpeakableSpecification
+
+
+class Article(CreativeWork):
+    """
+    An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.
+
+    See also [blog post](http://blog.schema.org/2014/09/schemaorg-support-for-bibliographic_2.html).
+    """
+
+    pageStart: Optional[Union[str, List[str], int, List[int]]] = None
+    speakable: Optional[
+        Union[
+            HttpUrl, List[HttpUrl], SpeakableSpecification, List[SpeakableSpecification]
+        ]
+    ] = None
+    articleSection: Optional[Union[str, List[str]]] = None
+    pagination: Optional[Union[str, List[str]]] = None
+    wordCount: Optional[Union[int, List[int]]] = None
+    articleBody: Optional[Union[str, List[str]]] = None
+    backstory: Optional[Union[CreativeWork, List[CreativeWork], str, List[str]]] = None
+    pageEnd: Optional[Union[int, List[int], str, List[str]]] = None

schema_models/ask_action.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.communicate_action import CommunicateAction
+from schema_models.question import Question
+
+
+class AskAction(CommunicateAction):
+    """
+    The act of posing a question / favor to someone.
+
+    Related actions:
+
+    * [[ReplyAction]]: Appears generally as a response to AskAction.
+    """
+
+    question: Optional[Union[Question, List[Question]]] = None

schema_models/ask_public_news_article.py

@@ -0,0 +1,7 @@
+from schema_models.news_article import NewsArticle
+
+
+class AskPublicNewsArticle(NewsArticle):
+    """
+    A [[NewsArticle]] expressing an open call by a [[NewsMediaOrganization]] asking the public for input, insights, clarifications, anecdotes, documentation, etc., on an issue, for reporting purposes.
+    """

schema_models/assess_action.py

@@ -0,0 +1,7 @@
+from schema_models.action import Action
+
+
+class AssessAction(Action):
+    """
+    The act of forming one's opinion, reaction or sentiment.
+    """

schema_models/assign_action.py

@@ -0,0 +1,7 @@
+from schema_models.allocate_action import AllocateAction
+
+
+class AssignAction(AllocateAction):
+    """
+    The act of allocating an action/event/task to some destination (someone or something).
+    """

schema_models/atlas.py

@@ -0,0 +1,7 @@
+from schema_models.creative_work import CreativeWork
+
+
+class Atlas(CreativeWork):
+    """
+    A collection or bound volume of maps, charts, plates or tables, physical or in media form illustrating any subject.
+    """

schema_models/attorney.py

@@ -0,0 +1,9 @@
+from schema_models.legal_service import LegalService
+
+
+class Attorney(LegalService):
+    """
+    Professional service: Attorney.
+
+    This type is deprecated - [[LegalService]] is more inclusive and less ambiguous.
+    """

schema_models/audience.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+
+
+class Audience(Intangible):
+    """
+    Intended audience for an item, i.e. the group for whom the item was created.
+    """
+
+    audienceType: Optional[Union[str, List[str]]] = None
+    geographicArea: Optional[
+        Union["AdministrativeArea", List["AdministrativeArea"]]
+    ] = None

schema_models/audio_object.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.media_object import MediaObject
+
+
+class AudioObject(MediaObject):
+    """
+    An audio file.
+    """
+
+    embeddedTextCaption: Optional[Union[str, List[str]]] = None
+    caption: Optional[Union[MediaObject, List[MediaObject], str, List[str]]] = None
+    transcript: Optional[Union[str, List[str]]] = None

schema_models/audio_object_snapshot.py

@@ -0,0 +1,7 @@
+from schema_models.audio_object import AudioObject
+
+
+class AudioObjectSnapshot(AudioObject):
+    """
+    A specific and exact (byte-for-byte) version of an [[AudioObject]]. Two byte-for-byte identical files, for the purposes of this type, considered identical. If they have different embedded metadata the files will differ. Different external facts about the files, e.g. creator or dateCreated that aren't represented in their actual content, do not affect this notion of identity.
+    """

schema_models/audiobook.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.audio_object import AudioObject
+from schema_models.duration import Duration
+from schema_models.person import Person
+
+
+class Audiobook(AudioObject):
+    """
+    An audiobook.
+    """
+
+    duration: Optional[Union[Duration, List[Duration]]] = None
+    readBy: Optional[Union[Person, List[Person]]] = None

schema_models/authorize_action.py

@@ -0,0 +1,26 @@
+from typing import List, Optional, Union
+
+from schema_models.allocate_action import AllocateAction
+from schema_models.audience import Audience
+from schema_models.contact_point import ContactPoint
+from schema_models.organization import Organization
+from schema_models.person import Person
+
+
+class AuthorizeAction(AllocateAction):
+    """
+    The act of granting permission to an object.
+    """
+
+    recipient: Optional[
+        Union[
+            Audience,
+            List[Audience],
+            ContactPoint,
+            List[ContactPoint],
+            Person,
+            List[Person],
+            Organization,
+            List[Organization],
+        ]
+    ] = None

schema_models/auto_body_shop.py

@@ -0,0 +1,7 @@
+from schema_models.automotive_business import AutomotiveBusiness
+
+
+class AutoBodyShop(AutomotiveBusiness):
+    """
+    Auto body shop.
+    """

schema_models/auto_dealer.py

@@ -0,0 +1,7 @@
+from schema_models.automotive_business import AutomotiveBusiness
+
+
+class AutoDealer(AutomotiveBusiness):
+    """
+    An car dealership.
+    """

schema_models/auto_parts_store.py

@@ -0,0 +1,7 @@
+from schema_models.store import Store
+
+
+class AutoPartsStore(Store):
+    """
+    An auto parts store.
+    """

schema_models/auto_rental.py

@@ -0,0 +1,7 @@
+from schema_models.automotive_business import AutomotiveBusiness
+
+
+class AutoRental(AutomotiveBusiness):
+    """
+    A car rental business.
+    """

schema_models/auto_repair.py

@@ -0,0 +1,7 @@
+from schema_models.automotive_business import AutomotiveBusiness
+
+
+class AutoRepair(AutomotiveBusiness):
+    """
+    Car repair business.
+    """

schema_models/auto_wash.py

@@ -0,0 +1,7 @@
+from schema_models.automotive_business import AutomotiveBusiness
+
+
+class AutoWash(AutomotiveBusiness):
+    """
+    A car wash business.
+    """

schema_models/automated_teller.py

@@ -0,0 +1,7 @@
+from schema_models.financial_service import FinancialService
+
+
+class AutomatedTeller(FinancialService):
+    """
+    ATM/cash machine.
+    """

schema_models/automotive_business.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class AutomotiveBusiness(LocalBusiness):
+    """
+    Car repair, sales, or parts.
+    """

schema_models/background_news_article.py

@@ -0,0 +1,7 @@
+from schema_models.news_article import NewsArticle
+
+
+class BackgroundNewsArticle(NewsArticle):
+    """
+    A [[NewsArticle]] providing historical context, definition and detail on a specific topic (aka "explainer" or "backgrounder"). For example, an in-depth article or frequently-asked-questions ([FAQ](https://en.wikipedia.org/wiki/FAQ)) document on topics such as Climate Change or the European Union. Other kinds of background material from a non-news setting are often described using [[Book]] or [[Article]], in particular [[ScholarlyArticle]]. See also [[NewsArticle]] for related vocabulary from a learning/education perspective.
+    """

schema_models/bakery.py

@@ -0,0 +1,7 @@
+from schema_models.food_establishment import FoodEstablishment
+
+
+class Bakery(FoodEstablishment):
+    """
+    A bakery.
+    """

schema_models/bank_account.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.financial_product import FinancialProduct
+from schema_models.monetary_amount import MonetaryAmount
+
+
+class BankAccount(FinancialProduct):
+    """
+    A product or service offered by a bank whereby one may deposit, withdraw or transfer money and in some cases be paid interest.
+    """
+
+    bankAccountType: Optional[Union[HttpUrl, List[HttpUrl], str, List[str]]] = None
+    accountOverdraftLimit: Optional[Union[MonetaryAmount, List[MonetaryAmount]]] = None
+    accountMinimumInflow: Optional[Union[MonetaryAmount, List[MonetaryAmount]]] = None

schema_models/bank_or_credit_union.py

@@ -0,0 +1,7 @@
+from schema_models.financial_service import FinancialService
+
+
+class BankOrCreditUnion(FinancialService):
+    """
+    Bank or credit union.
+    """

schema_models/bar_or_pub.py

@@ -0,0 +1,7 @@
+from schema_models.food_establishment import FoodEstablishment
+
+
+class BarOrPub(FoodEstablishment):
+    """
+    A bar or pub.
+    """

schema_models/barcode.py

@@ -0,0 +1,7 @@
+from schema_models.image_object import ImageObject
+
+
+class Barcode(ImageObject):
+    """
+    An image of a visual machine-readable code such as a barcode or QR code.
+    """

schema_models/beach.py

@@ -0,0 +1,7 @@
+from schema_models.civic_structure import CivicStructure
+
+
+class Beach(CivicStructure):
+    """
+    Beach.
+    """

schema_models/beauty_salon.py

@@ -0,0 +1,7 @@
+from schema_models.health_and_beauty_business import HealthAndBeautyBusiness
+
+
+class BeautySalon(HealthAndBeautyBusiness):
+    """
+    Beauty salon.
+    """

schema_models/bed_and_breakfast.py

@@ -0,0 +1,10 @@
+from schema_models.lodging_business import LodgingBusiness
+
+
+class BedAndBreakfast(LodgingBusiness):
+    """
+    Bed and breakfast.
+    <br /><br />
+    See also the <a href="/docs/hotels.html">dedicated document on the use of schema.org for marking up hotels and other forms of accommodations</a>.
+
+    """

schema_models/bed_details.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+
+
+class BedDetails(Intangible):
+    """
+    An entity holding detailed information about the available bed types, e.g. the quantity of twin beds for a hotel room. For the single case of just one bed of a certain type, you can use bed directly with a text. See also [[BedType]] (under development).
+    """
+
+    numberOfBeds: Optional[Union[float, List[float]]] = None
+    typeOfBed: Optional[Union["BedType", List["BedType"], str, List[str]]] = None

schema_models/bed_type.py

@@ -0,0 +1,7 @@
+from schema_models.qualitative_value import QualitativeValue
+
+
+class BedType(QualitativeValue):
+    """
+    A type of bed. This is used for indicating the bed or beds available in an accommodation.
+    """

schema_models/befriend_action.py

@@ -0,0 +1,11 @@
+from schema_models.interact_action import InteractAction
+
+
+class BefriendAction(InteractAction):
+    """
+    The act of forming a personal connection with someone (object) mutually/bidirectionally/symmetrically.
+
+    Related actions:
+
+    * [[FollowAction]]: Unlike FollowAction, BefriendAction implies that the connection is reciprocal.
+    """

schema_models/bike_store.py

@@ -0,0 +1,7 @@
+from schema_models.store import Store
+
+
+class BikeStore(Store):
+    """
+    A bike store.
+    """

schema_models/bio_chem_entity.py

@@ -0,0 +1,84 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.taxon import Taxon
+from schema_models.thing import Thing
+
+
+class BioChemEntity(Thing):
+    """
+    Any biological, chemical, or biochemical thing. For example: a protein; a gene; a chemical; a synthetic chemical.
+    """
+
+    funding: Optional[Union["Grant", List["Grant"]]] = None
+    hasMolecularFunction: Optional[
+        Union[
+            HttpUrl,
+            List[HttpUrl],
+            "DefinedTerm",
+            List["DefinedTerm"],
+            "PropertyValue",
+            List["PropertyValue"],
+        ]
+    ] = None
+    biologicalRole: Optional[Union["DefinedTerm", List["DefinedTerm"]]] = None
+    bioChemSimilarity: Optional[Union["BioChemEntity", List["BioChemEntity"]]] = None
+    taxonomicRange: Optional[
+        Union[
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+            "DefinedTerm",
+            List["DefinedTerm"],
+            Taxon,
+            List[Taxon],
+        ]
+    ] = None
+    isLocatedInSubcellularLocation: Optional[
+        Union[
+            HttpUrl,
+            List[HttpUrl],
+            "DefinedTerm",
+            List["DefinedTerm"],
+            "PropertyValue",
+            List["PropertyValue"],
+        ]
+    ] = None
+    hasRepresentation: Optional[
+        Union[
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+            "PropertyValue",
+            List["PropertyValue"],
+        ]
+    ] = None
+    bioChemInteraction: Optional[Union["BioChemEntity", List["BioChemEntity"]]] = None
+    isPartOfBioChemEntity: Optional[Union["BioChemEntity", List["BioChemEntity"]]] = (
+        None
+    )
+    hasBioChemEntityPart: Optional[Union["BioChemEntity", List["BioChemEntity"]]] = None
+    associatedDisease: Optional[
+        Union[
+            HttpUrl,
+            List[HttpUrl],
+            "PropertyValue",
+            List["PropertyValue"],
+            "MedicalCondition",
+            List["MedicalCondition"],
+        ]
+    ] = None
+    isInvolvedInBiologicalProcess: Optional[
+        Union[
+            "PropertyValue",
+            List["PropertyValue"],
+            HttpUrl,
+            List[HttpUrl],
+            "DefinedTerm",
+            List["DefinedTerm"],
+        ]
+    ] = None
+    isEncodedByBioChemEntity: Optional[Union["Gene", List["Gene"]]] = None

schema_models/blog.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+
+
+class Blog(CreativeWork):
+    """
+    A [blog](https://en.wikipedia.org/wiki/Blog), sometimes known as a "weblog". Note that the individual posts ([[BlogPosting]]s) in a [[Blog]] are often colloquially referred to by the same term.
+    """
+
+    blogPost: Optional[Union["BlogPosting", List["BlogPosting"]]] = None
+    issn: Optional[Union[str, List[str]]] = None
+    blogPosts: Optional[Union["BlogPosting", List["BlogPosting"]]] = None

schema_models/blog_posting.py

@@ -0,0 +1,7 @@
+from schema_models.social_media_posting import SocialMediaPosting
+
+
+class BlogPosting(SocialMediaPosting):
+    """
+    A blog post.
+    """

schema_models/blood_test.py

@@ -0,0 +1,7 @@
+from schema_models.medical_test import MedicalTest
+
+
+class BloodTest(MedicalTest):
+    """
+    A medical test performed on a sample of a patient's blood.
+    """

schema_models/boarding_policy_type.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class BoardingPolicyType(Enumeration):
+    """
+    A type of boarding policy used by an airline.
+    """

schema_models/boat_reservation.py

@@ -0,0 +1,9 @@
+from schema_models.reservation import Reservation
+
+
+class BoatReservation(Reservation):
+    """
+    A reservation for boat travel.
+
+    Note: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations. For offers of tickets, use [[Offer]].
+    """

schema_models/boat_terminal.py

@@ -0,0 +1,7 @@
+from schema_models.civic_structure import CivicStructure
+
+
+class BoatTerminal(CivicStructure):
+    """
+    A terminal for boats, ships, and other water vessels.
+    """

schema_models/boat_trip.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.trip import Trip
+
+
+class BoatTrip(Trip):
+    """
+    A trip on a commercial ferry line.
+    """
+
+    departureBoatTerminal: Optional[Union["BoatTerminal", List["BoatTerminal"]]] = None
+    arrivalBoatTerminal: Optional[Union["BoatTerminal", List["BoatTerminal"]]] = None

schema_models/body_measurement_type_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.measurement_type_enumeration import MeasurementTypeEnumeration
+
+
+class BodyMeasurementTypeEnumeration(MeasurementTypeEnumeration):
+    """
+    Enumerates types (or dimensions) of a person's body measurements, for example for fitting of clothes.
+    """

schema_models/body_of_water.py

@@ -0,0 +1,7 @@
+from schema_models.landform import Landform
+
+
+class BodyOfWater(Landform):
+    """
+    A body of water, such as a sea, ocean, or lake.
+    """

schema_models/bone.py

@@ -0,0 +1,7 @@
+from schema_models.anatomical_structure import AnatomicalStructure
+
+
+class Bone(AnatomicalStructure):
+    """
+    Rigid connective tissue that comprises up the skeletal structure of the human body.
+    """

schema_models/book.py

@@ -0,0 +1,17 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.person import Person
+
+
+class Book(CreativeWork):
+    """
+    A book.
+    """
+
+    numberOfPages: Optional[Union[int, List[int]]] = None
+    illustrator: Optional[Union[Person, List[Person]]] = None
+    abridged: Optional[Union[bool, List[bool]]] = None
+    bookEdition: Optional[Union[str, List[str]]] = None
+    isbn: Optional[Union[str, List[str]]] = None
+    bookFormat: Optional[Union["BookFormatType", List["BookFormatType"]]] = None

schema_models/book_format_type.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class BookFormatType(Enumeration):
+    """
+    The publication format of the book.
+    """

schema_models/book_series.py

@@ -0,0 +1,7 @@
+from schema_models.creative_work_series import CreativeWorkSeries
+
+
+class BookSeries(CreativeWorkSeries):
+    """
+    A series of books. Included books can be indicated with the hasPart property.
+    """

schema_models/book_store.py

@@ -0,0 +1,7 @@
+from schema_models.store import Store
+
+
+class BookStore(Store):
+    """
+    A bookstore.
+    """

schema_models/bookmark_action.py

@@ -0,0 +1,7 @@
+from schema_models.organize_action import OrganizeAction
+
+
+class BookmarkAction(OrganizeAction):
+    """
+    An agent bookmarks/flags/labels/tags/marks an object.
+    """

schema_models/boolean.py

@@ -0,0 +1,6 @@
+from fquery.pydantic import pydantic
+
+
+@pydantic
+class Boolean:
+    pass

schema_models/borrow_action.py

@@ -0,0 +1,19 @@
+from typing import List, Optional, Union
+
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.transfer_action import TransferAction
+
+
+class BorrowAction(TransferAction):
+    """
+    The act of obtaining an object under an agreement to return it at a later date. Reciprocal of LendAction.
+
+    Related actions:
+
+    * [[LendAction]]: Reciprocal of BorrowAction.
+    """
+
+    lender: Optional[Union[Person, List[Person], Organization, List[Organization]]] = (
+        None
+    )