summaryrefslogtreecommitdiff
path: root/python-py-algorand-sdk.spec
diff options
context:
space:
mode:
authorCoprDistGit <infra@openeuler.org>2023-04-12 00:48:37 +0000
committerCoprDistGit <infra@openeuler.org>2023-04-12 00:48:37 +0000
commit5740ed66f8cb6d91c1315ee3e795111e1905cb98 (patch)
tree4dfb1ef71b5d39d50b2e26a1ec2134ba48450a99 /python-py-algorand-sdk.spec
parentd22446a76ea24b3878f140138016db6bf144eaa3 (diff)
automatic import of python-py-algorand-sdk
Diffstat (limited to 'python-py-algorand-sdk.spec')
-rw-r--r--python-py-algorand-sdk.spec429
1 files changed, 429 insertions, 0 deletions
diff --git a/python-py-algorand-sdk.spec b/python-py-algorand-sdk.spec
new file mode 100644
index 0000000..1fe61e5
--- /dev/null
+++ b/python-py-algorand-sdk.spec
@@ -0,0 +1,429 @@
+%global _empty_manifest_terminate_build 0
+Name: python-py-algorand-sdk
+Version: 2.1.2
+Release: 1
+Summary: Algorand SDK in Python
+License: MIT
+URL: https://github.com/algorand/py-algorand-sdk
+Source0: https://mirrors.nju.edu.cn/pypi/web/packages/01/4e/61dac2820eae986ec6785f20368eef8a0186072e1bbab7dffdfccd727375/py-algorand-sdk-2.1.2.tar.gz
+BuildArch: noarch
+
+Requires: python3-pynacl
+Requires: python3-pycryptodomex
+Requires: python3-msgpack
+
+%description
+# py-algorand-sdk
+
+[![PyPI version](https://badge.fury.io/py/py-algorand-sdk.svg)](https://badge.fury.io/py/py-algorand-sdk)
+[![Documentation Status](https://readthedocs.org/projects/py-algorand-sdk/badge/?version=latest&style=flat)](https://py-algorand-sdk.readthedocs.io/en/latest)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+A python library for interacting with the Algorand network.
+
+## Installation
+
+Run `$ pip3 install py-algorand-sdk` to install the package.
+
+Alternatively, choose a [distribution file](https://pypi.org/project/py-algorand-sdk/#files), and run `$ pip3 install [file name]`.
+
+## Supported Python versions
+
+py-algorand-sdk's minimum Python version policy attempts to balance several constraints.
+
+* Make it easy for the community to use py-algorand-sdk by minimizing or excluding the need to customize Python installations.
+* Provide maintainers with access to newer language features that produce more robust software.
+
+Given these constraints, the minimum Python version policy is:
+Target Python version on newest [Ubuntu LTS](https://wiki.ubuntu.com/Releases) released >= 6 months ago.
+
+The rationale is:
+
+* If a major Linux OS distribution bumps a Python version, then it's sufficiently available to the community for us to upgrade.
+* The 6 month time buffer ensures we delay upgrades until the community starts using a recently released LTS version.
+
+## SDK Development
+
+Install dependencies
+
+* `pip3 install -r requirements.txt`
+
+Run tests
+
+* `make docker-test`
+
+Set up the Algorand Sandbox based test-harness without running the tests
+
+* `make harness`
+
+Format code
+
+* `black .`
+
+Update `algosdk/__init__.pyi` which allows downstream developers importing `algosdk` and using VSCode's PyLance to have improved type analysis
+
+* `make generate-init`
+
+Lint types
+
+* `make mypy` (or `mypy algosdk`)
+
+Check all lints required by the C.I. process
+
+* `make lint`
+
+Run non-test-harness related unit tests
+
+* `make pytest-unit`
+
+## Quick start
+
+Here's a simple example you can run without a node.
+
+```python
+from algosdk import account, encoding
+
+# generate an account
+private_key, address = account.generate_account()
+print("Private key:", private_key)
+print("Address:", address)
+
+# check if the address is valid
+if encoding.is_valid_address(address):
+ print("The address is valid!")
+else:
+ print("The address is invalid.")
+```
+
+## Node setup
+
+Follow the instructions in Algorand's [developer resources](https://developer.algorand.org/docs/run-a-node/setup/install/) to install a node on your computer.
+You can also set up a local [Algorand Sandbox](https://github.com/algorand/sandbox) with `make harness`.
+
+## Running examples/example.py
+
+Before running [example.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/example.py), start kmd on a private network or testnet node:
+
+```bash
+./goal kmd start -d [data directory]
+```
+
+Next, create a wallet and an account:
+
+```bash
+./goal wallet new [wallet name] -d [data directory]
+```
+
+```bash
+./goal account new -d [data directory] -w [wallet name]
+```
+
+Visit the [Algorand dispenser](https://bank.testnet.algorand.network/) and enter the account address to fund your account.
+
+Next, in [tokens.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/tokens.py), either update the tokens and addresses, or provide a path to the data directory. Alternatively, `tokens.py` also defaults to the sandbox harness configurations for algod and kmd, which can be brought up by running `make harness`.
+
+You're now ready to run example.py!
+
+## Documentation
+
+Documentation for the Python SDK is available at [py-algorand-sdk.readthedocs.io](https://py-algorand-sdk.readthedocs.io/en/latest/).
+
+## License
+
+py-algorand-sdk is licensed under an MIT license. See the [LICENSE](https://github.com/algorand/py-algorand-sdk/blob/master/LICENSE) file for details.
+
+
+%package -n python3-py-algorand-sdk
+Summary: Algorand SDK in Python
+Provides: python-py-algorand-sdk
+BuildRequires: python3-devel
+BuildRequires: python3-setuptools
+BuildRequires: python3-pip
+%description -n python3-py-algorand-sdk
+# py-algorand-sdk
+
+[![PyPI version](https://badge.fury.io/py/py-algorand-sdk.svg)](https://badge.fury.io/py/py-algorand-sdk)
+[![Documentation Status](https://readthedocs.org/projects/py-algorand-sdk/badge/?version=latest&style=flat)](https://py-algorand-sdk.readthedocs.io/en/latest)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+A python library for interacting with the Algorand network.
+
+## Installation
+
+Run `$ pip3 install py-algorand-sdk` to install the package.
+
+Alternatively, choose a [distribution file](https://pypi.org/project/py-algorand-sdk/#files), and run `$ pip3 install [file name]`.
+
+## Supported Python versions
+
+py-algorand-sdk's minimum Python version policy attempts to balance several constraints.
+
+* Make it easy for the community to use py-algorand-sdk by minimizing or excluding the need to customize Python installations.
+* Provide maintainers with access to newer language features that produce more robust software.
+
+Given these constraints, the minimum Python version policy is:
+Target Python version on newest [Ubuntu LTS](https://wiki.ubuntu.com/Releases) released >= 6 months ago.
+
+The rationale is:
+
+* If a major Linux OS distribution bumps a Python version, then it's sufficiently available to the community for us to upgrade.
+* The 6 month time buffer ensures we delay upgrades until the community starts using a recently released LTS version.
+
+## SDK Development
+
+Install dependencies
+
+* `pip3 install -r requirements.txt`
+
+Run tests
+
+* `make docker-test`
+
+Set up the Algorand Sandbox based test-harness without running the tests
+
+* `make harness`
+
+Format code
+
+* `black .`
+
+Update `algosdk/__init__.pyi` which allows downstream developers importing `algosdk` and using VSCode's PyLance to have improved type analysis
+
+* `make generate-init`
+
+Lint types
+
+* `make mypy` (or `mypy algosdk`)
+
+Check all lints required by the C.I. process
+
+* `make lint`
+
+Run non-test-harness related unit tests
+
+* `make pytest-unit`
+
+## Quick start
+
+Here's a simple example you can run without a node.
+
+```python
+from algosdk import account, encoding
+
+# generate an account
+private_key, address = account.generate_account()
+print("Private key:", private_key)
+print("Address:", address)
+
+# check if the address is valid
+if encoding.is_valid_address(address):
+ print("The address is valid!")
+else:
+ print("The address is invalid.")
+```
+
+## Node setup
+
+Follow the instructions in Algorand's [developer resources](https://developer.algorand.org/docs/run-a-node/setup/install/) to install a node on your computer.
+You can also set up a local [Algorand Sandbox](https://github.com/algorand/sandbox) with `make harness`.
+
+## Running examples/example.py
+
+Before running [example.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/example.py), start kmd on a private network or testnet node:
+
+```bash
+./goal kmd start -d [data directory]
+```
+
+Next, create a wallet and an account:
+
+```bash
+./goal wallet new [wallet name] -d [data directory]
+```
+
+```bash
+./goal account new -d [data directory] -w [wallet name]
+```
+
+Visit the [Algorand dispenser](https://bank.testnet.algorand.network/) and enter the account address to fund your account.
+
+Next, in [tokens.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/tokens.py), either update the tokens and addresses, or provide a path to the data directory. Alternatively, `tokens.py` also defaults to the sandbox harness configurations for algod and kmd, which can be brought up by running `make harness`.
+
+You're now ready to run example.py!
+
+## Documentation
+
+Documentation for the Python SDK is available at [py-algorand-sdk.readthedocs.io](https://py-algorand-sdk.readthedocs.io/en/latest/).
+
+## License
+
+py-algorand-sdk is licensed under an MIT license. See the [LICENSE](https://github.com/algorand/py-algorand-sdk/blob/master/LICENSE) file for details.
+
+
+%package help
+Summary: Development documents and examples for py-algorand-sdk
+Provides: python3-py-algorand-sdk-doc
+%description help
+# py-algorand-sdk
+
+[![PyPI version](https://badge.fury.io/py/py-algorand-sdk.svg)](https://badge.fury.io/py/py-algorand-sdk)
+[![Documentation Status](https://readthedocs.org/projects/py-algorand-sdk/badge/?version=latest&style=flat)](https://py-algorand-sdk.readthedocs.io/en/latest)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+A python library for interacting with the Algorand network.
+
+## Installation
+
+Run `$ pip3 install py-algorand-sdk` to install the package.
+
+Alternatively, choose a [distribution file](https://pypi.org/project/py-algorand-sdk/#files), and run `$ pip3 install [file name]`.
+
+## Supported Python versions
+
+py-algorand-sdk's minimum Python version policy attempts to balance several constraints.
+
+* Make it easy for the community to use py-algorand-sdk by minimizing or excluding the need to customize Python installations.
+* Provide maintainers with access to newer language features that produce more robust software.
+
+Given these constraints, the minimum Python version policy is:
+Target Python version on newest [Ubuntu LTS](https://wiki.ubuntu.com/Releases) released >= 6 months ago.
+
+The rationale is:
+
+* If a major Linux OS distribution bumps a Python version, then it's sufficiently available to the community for us to upgrade.
+* The 6 month time buffer ensures we delay upgrades until the community starts using a recently released LTS version.
+
+## SDK Development
+
+Install dependencies
+
+* `pip3 install -r requirements.txt`
+
+Run tests
+
+* `make docker-test`
+
+Set up the Algorand Sandbox based test-harness without running the tests
+
+* `make harness`
+
+Format code
+
+* `black .`
+
+Update `algosdk/__init__.pyi` which allows downstream developers importing `algosdk` and using VSCode's PyLance to have improved type analysis
+
+* `make generate-init`
+
+Lint types
+
+* `make mypy` (or `mypy algosdk`)
+
+Check all lints required by the C.I. process
+
+* `make lint`
+
+Run non-test-harness related unit tests
+
+* `make pytest-unit`
+
+## Quick start
+
+Here's a simple example you can run without a node.
+
+```python
+from algosdk import account, encoding
+
+# generate an account
+private_key, address = account.generate_account()
+print("Private key:", private_key)
+print("Address:", address)
+
+# check if the address is valid
+if encoding.is_valid_address(address):
+ print("The address is valid!")
+else:
+ print("The address is invalid.")
+```
+
+## Node setup
+
+Follow the instructions in Algorand's [developer resources](https://developer.algorand.org/docs/run-a-node/setup/install/) to install a node on your computer.
+You can also set up a local [Algorand Sandbox](https://github.com/algorand/sandbox) with `make harness`.
+
+## Running examples/example.py
+
+Before running [example.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/example.py), start kmd on a private network or testnet node:
+
+```bash
+./goal kmd start -d [data directory]
+```
+
+Next, create a wallet and an account:
+
+```bash
+./goal wallet new [wallet name] -d [data directory]
+```
+
+```bash
+./goal account new -d [data directory] -w [wallet name]
+```
+
+Visit the [Algorand dispenser](https://bank.testnet.algorand.network/) and enter the account address to fund your account.
+
+Next, in [tokens.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/tokens.py), either update the tokens and addresses, or provide a path to the data directory. Alternatively, `tokens.py` also defaults to the sandbox harness configurations for algod and kmd, which can be brought up by running `make harness`.
+
+You're now ready to run example.py!
+
+## Documentation
+
+Documentation for the Python SDK is available at [py-algorand-sdk.readthedocs.io](https://py-algorand-sdk.readthedocs.io/en/latest/).
+
+## License
+
+py-algorand-sdk is licensed under an MIT license. See the [LICENSE](https://github.com/algorand/py-algorand-sdk/blob/master/LICENSE) file for details.
+
+
+%prep
+%autosetup -n py-algorand-sdk-2.1.2
+
+%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-py-algorand-sdk -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Wed Apr 12 2023 Python_Bot <Python_Bot@openeuler.org> - 2.1.2-1
+- Package Spec generated