diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-stencila-schema.spec | 414 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 416 insertions, 0 deletions
@@ -0,0 +1 @@ +/stencila-schema-1.16.1.tar.gz diff --git a/python-stencila-schema.spec b/python-stencila-schema.spec new file mode 100644 index 0000000..a8a674e --- /dev/null +++ b/python-stencila-schema.spec @@ -0,0 +1,414 @@ +%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.nju.edu.cn/pypi/web/packages/ee/3e/1f8ac7c654af867c88395c3b20a2a77745054fafd43ee241501e93bc92a2/stencila-schema-1.16.1.tar.gz +BuildArch: noarch + + +%description + +# Stencila Schema for Python + +[](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master) +[](https://codecov.io/gh/stencila/schema/tree/master/python) +[](https://github.com/psf/black) +[](https://pypi.org/project/stencila-schema) +[](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) +#<stencila.schema.types.Heading object at 0x7f2d038a3748> + +json = encode(heading) +print(json) +#{ +# "type": "Heading", +# "content": [ +# "Heading Text" +# ], +# "depth": 2 +#} + +decode(json) +#<stencila.schema.types.Heading object at 0x7fda7bbdd780> +``` + + + + +%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 + +[](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master) +[](https://codecov.io/gh/stencila/schema/tree/master/python) +[](https://github.com/psf/black) +[](https://pypi.org/project/stencila-schema) +[](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) +#<stencila.schema.types.Heading object at 0x7f2d038a3748> + +json = encode(heading) +print(json) +#{ +# "type": "Heading", +# "content": [ +# "Heading Text" +# ], +# "depth": 2 +#} + +decode(json) +#<stencila.schema.types.Heading object at 0x7fda7bbdd780> +``` + + + + +%package help +Summary: Development documents and examples for stencila-schema +Provides: python3-stencila-schema-doc +%description help + +# Stencila Schema for Python + +[](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master) +[](https://codecov.io/gh/stencila/schema/tree/master/python) +[](https://github.com/psf/black) +[](https://pypi.org/project/stencila-schema) +[](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) +#<stencila.schema.types.Heading object at 0x7f2d038a3748> + +json = encode(heading) +print(json) +#{ +# "type": "Heading", +# "content": [ +# "Heading Text" +# ], +# "depth": 2 +#} + +decode(json) +#<stencila.schema.types.Heading object at 0x7fda7bbdd780> +``` + + + + +%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 May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 1.16.1-1 +- Package Spec generated @@ -0,0 +1 @@ +5cd1e692b1cc5d3e4aa93513627be11a stencila-schema-1.16.1.tar.gz |