%global _empty_manifest_terminate_build 0 Name: python-stencila-schema Version: 1.16.1 Release: 1 Summary: please add a summary manually as the author left a blank one License: Apache-2.0 URL: https://github.com/stencila/schema Source0: https://mirrors.aliyun.com/pypi/web/packages/ee/3e/1f8ac7c654af867c88395c3b20a2a77745054fafd43ee241501e93bc92a2/stencila-schema-1.16.1.tar.gz BuildArch: noarch %description # Stencila Schema for Python [![Build Status](https://dev.azure.com/stencila/stencila/_apis/build/status/stencila.schema?branchName=master)](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master) [![Code coverage](https://badger.nokome.now.sh/codecov-folder/stencila/schema/python)](https://codecov.io/gh/stencila/schema/tree/master/python) [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI](https://img.shields.io/pypi/v/stencila-schema.svg)](https://pypi.org/project/stencila-schema) [![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://stencila.github.io/schema/python/docs) This package provides Python bindings for the [Stencila Schema](https://schema.stenci.la) for executable documents. It is primarily aimed at Python developers wanting to programmatically generate, or modify, executable documents. For example, it is used in [`pyla`](https://github.com/stencila/pyla), a Stencila plugin for Python. ## Install ```python pip3 install stencila-schema ``` ## Use This packages exports a Python class for each type of document node in the Stencila Schema e.g. `Article`, `Paragraph`, `CodeChunk`. For type safety, type annotations are places on attributes and parameters of the `__init__` method. e.g. ```python class CodeExpression(CodeFragment): """An expression defined in programming language source code.""" errors: Optional[Array["CodeError"]] = None """Errors when compiling or executing the chunk.""" output: Optional["Node"] = None """The value of the expression when it was last evaluated.""" ``` The `__init__` method of each class has as parameters the attributes of the class (including those that are inherited) with required attributes first (alphabetically where there are more than one), followed by optional attributes (also alphabetically) e.g. for `CodeExpression`: ```python def __init__( self, text: str, errors: Optional[Array["CodeError"]] = None, format: Optional[str] = None, id: Optional[str] = None, meta: Optional[Dict[str, Any]] = None, output: Optional["Node"] = None, programmingLanguage: Optional[str] = None ) ``` It is recommended to use keyword arguments when calling constructors as it substantially reduces the likelihood that your code will break if you get the order wrong or if there are changes in the attributes of classes (and thus their order in `__init__` parameters) in later versions e.g. ```python from stencila.schema.types import Article, CodeExpression, Paragraph, Person article = Article( title="My first executable document", authors=[Person(givenNames=["Jane"], familyNames=["Doe"])], content=[ Paragraph( content=[ "Two times two: ", CodeExpression(programmingLanguage="python", text="2 * 2"), ] ) ], ) print(article.authors[0].givenNames) # Jane ``` In contrast, the following code is more concise, but is broken because, although it provides all required arguments, it gets the order wrong: ```python from stencila.schema.types import Article, CodeExpression, Paragraph, Person article = Article( "My first executable document", [Person(["Jane"], ["Doe"])], [Paragraph(["Two times two: ", CodeExpression("2 * 2", "python"),])], ) print(article.authors[0].address) # Jane print(article.authors[0].givenNames) # None ``` To support conversion of schema nodes to/from JSON, `json.py` defines `encode` and `decode` functions. e.g. ```python from stencila.schema.types import Heading from stencila.schema.json import encode, decode heading = Heading(content=["Heading Text"], depth=2) # json = encode(heading) print(json) #{ # "type": "Heading", # "content": [ # "Heading Text" # ], # "depth": 2 #} decode(json) # ``` %package -n python3-stencila-schema Summary: please add a summary manually as the author left a blank one Provides: python-stencila-schema BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-stencila-schema # Stencila Schema for Python [![Build Status](https://dev.azure.com/stencila/stencila/_apis/build/status/stencila.schema?branchName=master)](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master) [![Code coverage](https://badger.nokome.now.sh/codecov-folder/stencila/schema/python)](https://codecov.io/gh/stencila/schema/tree/master/python) [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI](https://img.shields.io/pypi/v/stencila-schema.svg)](https://pypi.org/project/stencila-schema) [![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://stencila.github.io/schema/python/docs) This package provides Python bindings for the [Stencila Schema](https://schema.stenci.la) for executable documents. It is primarily aimed at Python developers wanting to programmatically generate, or modify, executable documents. For example, it is used in [`pyla`](https://github.com/stencila/pyla), a Stencila plugin for Python. ## Install ```python pip3 install stencila-schema ``` ## Use This packages exports a Python class for each type of document node in the Stencila Schema e.g. `Article`, `Paragraph`, `CodeChunk`. For type safety, type annotations are places on attributes and parameters of the `__init__` method. e.g. ```python class CodeExpression(CodeFragment): """An expression defined in programming language source code.""" errors: Optional[Array["CodeError"]] = None """Errors when compiling or executing the chunk.""" output: Optional["Node"] = None """The value of the expression when it was last evaluated.""" ``` The `__init__` method of each class has as parameters the attributes of the class (including those that are inherited) with required attributes first (alphabetically where there are more than one), followed by optional attributes (also alphabetically) e.g. for `CodeExpression`: ```python def __init__( self, text: str, errors: Optional[Array["CodeError"]] = None, format: Optional[str] = None, id: Optional[str] = None, meta: Optional[Dict[str, Any]] = None, output: Optional["Node"] = None, programmingLanguage: Optional[str] = None ) ``` It is recommended to use keyword arguments when calling constructors as it substantially reduces the likelihood that your code will break if you get the order wrong or if there are changes in the attributes of classes (and thus their order in `__init__` parameters) in later versions e.g. ```python from stencila.schema.types import Article, CodeExpression, Paragraph, Person article = Article( title="My first executable document", authors=[Person(givenNames=["Jane"], familyNames=["Doe"])], content=[ Paragraph( content=[ "Two times two: ", CodeExpression(programmingLanguage="python", text="2 * 2"), ] ) ], ) print(article.authors[0].givenNames) # Jane ``` In contrast, the following code is more concise, but is broken because, although it provides all required arguments, it gets the order wrong: ```python from stencila.schema.types import Article, CodeExpression, Paragraph, Person article = Article( "My first executable document", [Person(["Jane"], ["Doe"])], [Paragraph(["Two times two: ", CodeExpression("2 * 2", "python"),])], ) print(article.authors[0].address) # Jane print(article.authors[0].givenNames) # None ``` To support conversion of schema nodes to/from JSON, `json.py` defines `encode` and `decode` functions. e.g. ```python from stencila.schema.types import Heading from stencila.schema.json import encode, decode heading = Heading(content=["Heading Text"], depth=2) # json = encode(heading) print(json) #{ # "type": "Heading", # "content": [ # "Heading Text" # ], # "depth": 2 #} decode(json) # ``` %package help Summary: Development documents and examples for stencila-schema Provides: python3-stencila-schema-doc %description help # Stencila Schema for Python [![Build Status](https://dev.azure.com/stencila/stencila/_apis/build/status/stencila.schema?branchName=master)](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master) [![Code coverage](https://badger.nokome.now.sh/codecov-folder/stencila/schema/python)](https://codecov.io/gh/stencila/schema/tree/master/python) [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI](https://img.shields.io/pypi/v/stencila-schema.svg)](https://pypi.org/project/stencila-schema) [![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://stencila.github.io/schema/python/docs) This package provides Python bindings for the [Stencila Schema](https://schema.stenci.la) for executable documents. It is primarily aimed at Python developers wanting to programmatically generate, or modify, executable documents. For example, it is used in [`pyla`](https://github.com/stencila/pyla), a Stencila plugin for Python. ## Install ```python pip3 install stencila-schema ``` ## Use This packages exports a Python class for each type of document node in the Stencila Schema e.g. `Article`, `Paragraph`, `CodeChunk`. For type safety, type annotations are places on attributes and parameters of the `__init__` method. e.g. ```python class CodeExpression(CodeFragment): """An expression defined in programming language source code.""" errors: Optional[Array["CodeError"]] = None """Errors when compiling or executing the chunk.""" output: Optional["Node"] = None """The value of the expression when it was last evaluated.""" ``` The `__init__` method of each class has as parameters the attributes of the class (including those that are inherited) with required attributes first (alphabetically where there are more than one), followed by optional attributes (also alphabetically) e.g. for `CodeExpression`: ```python def __init__( self, text: str, errors: Optional[Array["CodeError"]] = None, format: Optional[str] = None, id: Optional[str] = None, meta: Optional[Dict[str, Any]] = None, output: Optional["Node"] = None, programmingLanguage: Optional[str] = None ) ``` It is recommended to use keyword arguments when calling constructors as it substantially reduces the likelihood that your code will break if you get the order wrong or if there are changes in the attributes of classes (and thus their order in `__init__` parameters) in later versions e.g. ```python from stencila.schema.types import Article, CodeExpression, Paragraph, Person article = Article( title="My first executable document", authors=[Person(givenNames=["Jane"], familyNames=["Doe"])], content=[ Paragraph( content=[ "Two times two: ", CodeExpression(programmingLanguage="python", text="2 * 2"), ] ) ], ) print(article.authors[0].givenNames) # Jane ``` In contrast, the following code is more concise, but is broken because, although it provides all required arguments, it gets the order wrong: ```python from stencila.schema.types import Article, CodeExpression, Paragraph, Person article = Article( "My first executable document", [Person(["Jane"], ["Doe"])], [Paragraph(["Two times two: ", CodeExpression("2 * 2", "python"),])], ) print(article.authors[0].address) # Jane print(article.authors[0].givenNames) # None ``` To support conversion of schema nodes to/from JSON, `json.py` defines `encode` and `decode` functions. e.g. ```python from stencila.schema.types import Heading from stencila.schema.json import encode, decode heading = Heading(content=["Heading Text"], depth=2) # json = encode(heading) print(json) #{ # "type": "Heading", # "content": [ # "Heading Text" # ], # "depth": 2 #} decode(json) # ``` %prep %autosetup -n stencila-schema-1.16.1 %build %py3_build %install %py3_install install -d -m755 %{buildroot}/%{_pkgdocdir} if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi pushd %{buildroot} if [ -d usr/lib ]; then find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/lib64 ]; then find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/bin ]; then find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/sbin ]; then find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi touch doclist.lst if [ -d usr/share/man ]; then find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst fi popd mv %{buildroot}/filelist.lst . mv %{buildroot}/doclist.lst . %files -n python3-stencila-schema -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Thu Jun 08 2023 Python_Bot - 1.16.1-1 - Package Spec generated