diff options
Diffstat (limited to 'python-atoml.spec')
| -rw-r--r-- | python-atoml.spec | 606 |
1 files changed, 606 insertions, 0 deletions
diff --git a/python-atoml.spec b/python-atoml.spec new file mode 100644 index 0000000..d3fb918 --- /dev/null +++ b/python-atoml.spec @@ -0,0 +1,606 @@ +%global _empty_manifest_terminate_build 0 +Name: python-atoml +Version: 1.1.1 +Release: 1 +Summary: Yet another style preserving TOML library +License: MIT +URL: https://github.com/frostming/atoml.git +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/df/bb/d9733f8070c6bb66817a27ec53a0847c63b53395d797d091a477ece5f4c7/atoml-1.1.1.tar.gz +BuildArch: noarch + + +%description +[pypi_version]: https://img.shields.io/pypi/v/atoml.svg?logo=python&logoColor=white +[python_versions]: https://img.shields.io/pypi/pyversions/atoml.svg?logo=python&logoColor=white +[github_license]: https://img.shields.io/github/license/frostming/atoml.svg?logo=github&logoColor=white + +[![PyPI Version][pypi_version]](https://pypi.python.org/pypi/atoml/) +[![Python Versions][python_versions]](https://pypi.python.org/pypi/atoml/) +[![License][github_license]](https://github.com/frostming/atoml/blob/master/LICENSE) + +[](https://codecov.io/gh/frostming/atoml) + +# ATOML - Yet another style-preserving TOML library for Python + +ATOML is a **1.0.0rc1-compliant** [TOML](https://github.com/toml-lang/toml) library. + +It includes a parser that preserves all comments, indentations, whitespace and internal element ordering, and makes them accessible and editable via an intuitive API. + +You can also create new TOML documents from scratch using the provided helpers. + +The name comes from the famous Japanese cartoon character **鉄腕アトム(Atom)**. + +_**Implementation Change**: Start from 1.0, ATOML is a fork of [tomlkit v0.7.0](https://github.com/sdispater/tomlkit) with less bugs and inconsistency._ + +## Usage + +### Parsing + +ATOML comes with a fast and style-preserving parser to help you access +the content of TOML files and strings. + +```python +>>> from atoml import dumps +>>> from atoml import parse # you can also use loads + +>>> content = """[table] +... foo = "bar" # String +... """ +>>> doc = parse(content) + +# doc is a TOMLDocument instance that holds all the information +# about the TOML string. +# It behaves like a standard dictionary. + +>>> assert doc["table"]["foo"] == "bar" + +# The string generated from the document is exactly the same +# as the original string +>>> assert dumps(doc) == content +``` + +### Modifying + +ATOML provides an intuitive API to modify TOML documents. + +```python +>>> from atoml import dumps +>>> from atoml import parse +>>> from atoml import table + +>>> doc = parse("""[table] +... foo = "bar" # String +... """) + +>>> doc["table"]["baz"] = 13 + +>>> dumps(doc) +"""[table] +foo = "bar" # String +baz = 13 +""" + +# Add a new table +>>> tab = table() +>>> tab.add("array", [1, 2, 3]) + +>>> doc["table2"] = tab + +>>> dumps(doc) +"""[table] +foo = "bar" # String +baz = 13 + +[table2] +array = [1, 2, 3] +""" + +# Remove the newly added table +>>> doc.remove("table2") +# del doc["table2] is also possible +``` + +### Writing + +You can also write a new TOML document from scratch. + +Let's say we want to create this following document: + +```toml +# This is a TOML document. + +title = "TOML Example" + +[owner] +name = "Tom Preston-Werner" +organization = "GitHub" +bio = "GitHub Cofounder & CEO\nLikes tater tots and beer." +dob = 1979-05-27T07:32:00Z # First class dates? Why not? + +[database] +server = "192.168.1.1" +ports = [ 8001, 8001, 8002 ] +connection_max = 5000 +enabled = true +``` + +It can be created with the following code: + +```python +>>> from atoml import comment +>>> from atoml import document +>>> from atoml import nl +>>> from atoml import table + +>>> doc = document() +>>> doc.add(comment("This is a TOML document.")) +>>> doc.add(nl()) +>>> doc.add("title", "TOML Example") +# Using doc["title"] = "TOML Example" is also possible + +>>> owner = table() +>>> owner.add("name", "Tom Preston-Werner") +>>> owner.add("organization", "GitHub") +>>> owner.add("bio", "GitHub Cofounder & CEO\nLikes tater tots and beer.") +>>> owner.add("dob", datetime(1979, 5, 27, 7, 32, tzinfo=utc)) +>>> owner["dob"].comment("First class dates? Why not?") + +# Adding the table to the document +>>> doc.add("owner", owner) + +>>> database = table() +>>> database["server"] = "192.168.1.1" +>>> database["ports"] = [8001, 8001, 8002] +>>> database["connection_max"] = 5000 +>>> database["enabled"] = True + +>>> doc["database"] = database +``` + + +## Installation + +If you are using [PDM](https://pdm.fming.dev), +add `atoml` to your `pyproject.toml` file by using: + +```bash +pdm add atoml +``` + +If not, you can use `pip`: + +```bash +pip install atoml +``` + +## Migrate from TOMLKit + +ATOML comes with full compatible API with TOMLKit, you can easily do a Replace All of `tomlkit` to `atoml` or: + +```python +import atoml as tomlkit +``` + +ATOML differs from TOMLkit in the following ways: + +- Python 3.6+ support only +- Tables and arrays are subclasses of `MutableMapping` and `MutableSequence` respectively, to reduce some inconsistency between the container behaviors +- `load` and `dump` methods added +- [Less bugs](https://github.com/frostming/atoml/issues/9) + + + +%package -n python3-atoml +Summary: Yet another style preserving TOML library +Provides: python-atoml +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-atoml +[pypi_version]: https://img.shields.io/pypi/v/atoml.svg?logo=python&logoColor=white +[python_versions]: https://img.shields.io/pypi/pyversions/atoml.svg?logo=python&logoColor=white +[github_license]: https://img.shields.io/github/license/frostming/atoml.svg?logo=github&logoColor=white + +[![PyPI Version][pypi_version]](https://pypi.python.org/pypi/atoml/) +[![Python Versions][python_versions]](https://pypi.python.org/pypi/atoml/) +[![License][github_license]](https://github.com/frostming/atoml/blob/master/LICENSE) + +[](https://codecov.io/gh/frostming/atoml) + +# ATOML - Yet another style-preserving TOML library for Python + +ATOML is a **1.0.0rc1-compliant** [TOML](https://github.com/toml-lang/toml) library. + +It includes a parser that preserves all comments, indentations, whitespace and internal element ordering, and makes them accessible and editable via an intuitive API. + +You can also create new TOML documents from scratch using the provided helpers. + +The name comes from the famous Japanese cartoon character **鉄腕アトム(Atom)**. + +_**Implementation Change**: Start from 1.0, ATOML is a fork of [tomlkit v0.7.0](https://github.com/sdispater/tomlkit) with less bugs and inconsistency._ + +## Usage + +### Parsing + +ATOML comes with a fast and style-preserving parser to help you access +the content of TOML files and strings. + +```python +>>> from atoml import dumps +>>> from atoml import parse # you can also use loads + +>>> content = """[table] +... foo = "bar" # String +... """ +>>> doc = parse(content) + +# doc is a TOMLDocument instance that holds all the information +# about the TOML string. +# It behaves like a standard dictionary. + +>>> assert doc["table"]["foo"] == "bar" + +# The string generated from the document is exactly the same +# as the original string +>>> assert dumps(doc) == content +``` + +### Modifying + +ATOML provides an intuitive API to modify TOML documents. + +```python +>>> from atoml import dumps +>>> from atoml import parse +>>> from atoml import table + +>>> doc = parse("""[table] +... foo = "bar" # String +... """) + +>>> doc["table"]["baz"] = 13 + +>>> dumps(doc) +"""[table] +foo = "bar" # String +baz = 13 +""" + +# Add a new table +>>> tab = table() +>>> tab.add("array", [1, 2, 3]) + +>>> doc["table2"] = tab + +>>> dumps(doc) +"""[table] +foo = "bar" # String +baz = 13 + +[table2] +array = [1, 2, 3] +""" + +# Remove the newly added table +>>> doc.remove("table2") +# del doc["table2] is also possible +``` + +### Writing + +You can also write a new TOML document from scratch. + +Let's say we want to create this following document: + +```toml +# This is a TOML document. + +title = "TOML Example" + +[owner] +name = "Tom Preston-Werner" +organization = "GitHub" +bio = "GitHub Cofounder & CEO\nLikes tater tots and beer." +dob = 1979-05-27T07:32:00Z # First class dates? Why not? + +[database] +server = "192.168.1.1" +ports = [ 8001, 8001, 8002 ] +connection_max = 5000 +enabled = true +``` + +It can be created with the following code: + +```python +>>> from atoml import comment +>>> from atoml import document +>>> from atoml import nl +>>> from atoml import table + +>>> doc = document() +>>> doc.add(comment("This is a TOML document.")) +>>> doc.add(nl()) +>>> doc.add("title", "TOML Example") +# Using doc["title"] = "TOML Example" is also possible + +>>> owner = table() +>>> owner.add("name", "Tom Preston-Werner") +>>> owner.add("organization", "GitHub") +>>> owner.add("bio", "GitHub Cofounder & CEO\nLikes tater tots and beer.") +>>> owner.add("dob", datetime(1979, 5, 27, 7, 32, tzinfo=utc)) +>>> owner["dob"].comment("First class dates? Why not?") + +# Adding the table to the document +>>> doc.add("owner", owner) + +>>> database = table() +>>> database["server"] = "192.168.1.1" +>>> database["ports"] = [8001, 8001, 8002] +>>> database["connection_max"] = 5000 +>>> database["enabled"] = True + +>>> doc["database"] = database +``` + + +## Installation + +If you are using [PDM](https://pdm.fming.dev), +add `atoml` to your `pyproject.toml` file by using: + +```bash +pdm add atoml +``` + +If not, you can use `pip`: + +```bash +pip install atoml +``` + +## Migrate from TOMLKit + +ATOML comes with full compatible API with TOMLKit, you can easily do a Replace All of `tomlkit` to `atoml` or: + +```python +import atoml as tomlkit +``` + +ATOML differs from TOMLkit in the following ways: + +- Python 3.6+ support only +- Tables and arrays are subclasses of `MutableMapping` and `MutableSequence` respectively, to reduce some inconsistency between the container behaviors +- `load` and `dump` methods added +- [Less bugs](https://github.com/frostming/atoml/issues/9) + + + +%package help +Summary: Development documents and examples for atoml +Provides: python3-atoml-doc +%description help +[pypi_version]: https://img.shields.io/pypi/v/atoml.svg?logo=python&logoColor=white +[python_versions]: https://img.shields.io/pypi/pyversions/atoml.svg?logo=python&logoColor=white +[github_license]: https://img.shields.io/github/license/frostming/atoml.svg?logo=github&logoColor=white + +[![PyPI Version][pypi_version]](https://pypi.python.org/pypi/atoml/) +[![Python Versions][python_versions]](https://pypi.python.org/pypi/atoml/) +[![License][github_license]](https://github.com/frostming/atoml/blob/master/LICENSE) + +[](https://codecov.io/gh/frostming/atoml) + +# ATOML - Yet another style-preserving TOML library for Python + +ATOML is a **1.0.0rc1-compliant** [TOML](https://github.com/toml-lang/toml) library. + +It includes a parser that preserves all comments, indentations, whitespace and internal element ordering, and makes them accessible and editable via an intuitive API. + +You can also create new TOML documents from scratch using the provided helpers. + +The name comes from the famous Japanese cartoon character **鉄腕アトム(Atom)**. + +_**Implementation Change**: Start from 1.0, ATOML is a fork of [tomlkit v0.7.0](https://github.com/sdispater/tomlkit) with less bugs and inconsistency._ + +## Usage + +### Parsing + +ATOML comes with a fast and style-preserving parser to help you access +the content of TOML files and strings. + +```python +>>> from atoml import dumps +>>> from atoml import parse # you can also use loads + +>>> content = """[table] +... foo = "bar" # String +... """ +>>> doc = parse(content) + +# doc is a TOMLDocument instance that holds all the information +# about the TOML string. +# It behaves like a standard dictionary. + +>>> assert doc["table"]["foo"] == "bar" + +# The string generated from the document is exactly the same +# as the original string +>>> assert dumps(doc) == content +``` + +### Modifying + +ATOML provides an intuitive API to modify TOML documents. + +```python +>>> from atoml import dumps +>>> from atoml import parse +>>> from atoml import table + +>>> doc = parse("""[table] +... foo = "bar" # String +... """) + +>>> doc["table"]["baz"] = 13 + +>>> dumps(doc) +"""[table] +foo = "bar" # String +baz = 13 +""" + +# Add a new table +>>> tab = table() +>>> tab.add("array", [1, 2, 3]) + +>>> doc["table2"] = tab + +>>> dumps(doc) +"""[table] +foo = "bar" # String +baz = 13 + +[table2] +array = [1, 2, 3] +""" + +# Remove the newly added table +>>> doc.remove("table2") +# del doc["table2] is also possible +``` + +### Writing + +You can also write a new TOML document from scratch. + +Let's say we want to create this following document: + +```toml +# This is a TOML document. + +title = "TOML Example" + +[owner] +name = "Tom Preston-Werner" +organization = "GitHub" +bio = "GitHub Cofounder & CEO\nLikes tater tots and beer." +dob = 1979-05-27T07:32:00Z # First class dates? Why not? + +[database] +server = "192.168.1.1" +ports = [ 8001, 8001, 8002 ] +connection_max = 5000 +enabled = true +``` + +It can be created with the following code: + +```python +>>> from atoml import comment +>>> from atoml import document +>>> from atoml import nl +>>> from atoml import table + +>>> doc = document() +>>> doc.add(comment("This is a TOML document.")) +>>> doc.add(nl()) +>>> doc.add("title", "TOML Example") +# Using doc["title"] = "TOML Example" is also possible + +>>> owner = table() +>>> owner.add("name", "Tom Preston-Werner") +>>> owner.add("organization", "GitHub") +>>> owner.add("bio", "GitHub Cofounder & CEO\nLikes tater tots and beer.") +>>> owner.add("dob", datetime(1979, 5, 27, 7, 32, tzinfo=utc)) +>>> owner["dob"].comment("First class dates? Why not?") + +# Adding the table to the document +>>> doc.add("owner", owner) + +>>> database = table() +>>> database["server"] = "192.168.1.1" +>>> database["ports"] = [8001, 8001, 8002] +>>> database["connection_max"] = 5000 +>>> database["enabled"] = True + +>>> doc["database"] = database +``` + + +## Installation + +If you are using [PDM](https://pdm.fming.dev), +add `atoml` to your `pyproject.toml` file by using: + +```bash +pdm add atoml +``` + +If not, you can use `pip`: + +```bash +pip install atoml +``` + +## Migrate from TOMLKit + +ATOML comes with full compatible API with TOMLKit, you can easily do a Replace All of `tomlkit` to `atoml` or: + +```python +import atoml as tomlkit +``` + +ATOML differs from TOMLkit in the following ways: + +- Python 3.6+ support only +- Tables and arrays are subclasses of `MutableMapping` and `MutableSequence` respectively, to reduce some inconsistency between the container behaviors +- `load` and `dump` methods added +- [Less bugs](https://github.com/frostming/atoml/issues/9) + + + +%prep +%autosetup -n atoml-1.1.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-atoml -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.1.1-1 +- Package Spec generated |