diff options
Diffstat (limited to 'python-datacrunch.spec')
| -rw-r--r-- | python-datacrunch.spec | 602 |
1 files changed, 602 insertions, 0 deletions
diff --git a/python-datacrunch.spec b/python-datacrunch.spec new file mode 100644 index 0000000..f57561f --- /dev/null +++ b/python-datacrunch.spec @@ -0,0 +1,602 @@ +%global _empty_manifest_terminate_build 0 +Name: python-datacrunch +Version: 1.4.0 +Release: 1 +Summary: Official Python SDK for DataCrunch Public API +License: MIT License +URL: https://github.com/DataCrunch-io +Source0: https://mirrors.aliyun.com/pypi/web/packages/ee/fa/0d4492688757a6acbee5c0b562e50f8f3b8fc87c7f4a4d1b101903049877/datacrunch-1.4.0.tar.gz +BuildArch: noarch + +Requires: python3-requests +Requires: python3-pytest +Requires: python3-pytest-cov +Requires: python3-pytest-responses +Requires: python3-responses + +%description +# DataCrunch Python SDK + +<p> + <a href='https://github.com/DataCrunch-io/datacrunch-python/actions?query=workflow%3A%22Unit+Tests%22+branch%3Amaster'> + <img src='https://github.com/DataCrunch-io/datacrunch-python/workflows/Unit%20Tests/badge.svg'></img> + </a> + + <a href='https://github.com/DataCrunch-io/datacrunch-python/actions?query=workflow%3A%22Code+Style%22+branch%3Amaster'> + <img src='https://github.com/DataCrunch-io/datacrunch-python/workflows/Code%20Style/badge.svg'></img> + </a> + + <a href="https://codecov.io/gh/DataCrunch-io/datacrunch-python"> + <img src="https://codecov.io/gh/DataCrunch-io/datacrunch-python/branch/master/graph/badge.svg?token=5X5KTYSSPK"/> + </a> + + <a href='https://datacrunch-python.readthedocs.io/en/latest/'> + <img src='https://readthedocs.org/projects/datacrunch-python/badge/?version=latest'></img> + </a> + + <a href='https://github.com/DataCrunch-io/datacrunch-python/blob/master/LICENSE'> + <img src='https://img.shields.io/github/license/DataCrunch-io/datacrunch-python'></img> + </a> + + <a href='https://pypi.org/project/datacrunch/'> + <img src='https://img.shields.io/pypi/v/datacrunch?logo=python'></img> + </a> + + <a href='https://pypi.org/project/datacrunch/'> + <img src='https://img.shields.io/pypi/pyversions/datacrunch'></img> + </a> +</p> + +The official [DataCrunch.io](https://datacrunch.io) Python SDK. + +The SDK's documentation is available on [ReadTheDocs](https://datacrunch-python.readthedocs.io/en/latest/) + +DataCrunch's Public API documentation [is available here](https://datacrunch.stoplight.io/docs/datacrunch-public/docs/Overview/Introduction.md). + +## Getting Started - Using the SDK: + +- Install via pip: + + ```bash + pip3 install datacrunch + ``` + +- Generate your client credentials - [instructions in the public API docs](https://datacrunch.stoplight.io/docs/datacrunch-public/docs/Overview/Quick-Start-Guide.md). + +- Add the client secret to an environment variable (don't want it to be hardcoded): + + Linux (bash): + + ```bash + export DATACRUNCH_CLIENT_SECRET=Z4CZq02rdwdB7ISV0k4Z2gtwAFKiyvr2U1l0KDIeYi + ``` + + Other platforms: + https://en.wikipedia.org/wiki/Environment_variable + +- Example for creating a new instance: + + ```python + import os + from datacrunch import DataCrunchClient + + # Get client secret from environment variable + CLIENT_SECRET = os.environ['DATACRUNCH_CLIENT_SECRET'] + CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi' + + # Create datcrunch client + datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET) + + # Get all SSH keys + ssh_keys = datacrunch.ssh_keys.get() + ssh_keys = list(map(lambda key: key.id, ssh_keys)) + + # Create a new instance + instance = datacrunch.instances.create(instance_type='1V100.6V', + image='fastai', + ssh_key_ids=ssh_keys, + hostname='example', + description='example instance') + + # Delete instance + datacrunch.instances.action(instance.id, datacrunch.constants.instance_actions.DELETE) + ``` + + More examples can be found in the `/examples` folder or in the [documentation](https://datacrunch-python.readthedocs.io/en/latest/). + +## Development + +### Setting up the local development environment + +- Clone the repository: + + ```bash + git clone + ``` + +- Create local virtual environment: + + ```bash + python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate + ``` + + or if using [fish shell](https://fishshell.com/): + + ```fish + python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate.fish + ``` + +- Install Dependencies: + + ```bash + pip3 install -e .[test] + pip3 install -U pytest + ``` + +### Running Tests + +We use pytest for testing. + +- To execute all tests + + ```bash + pytest + ``` + +- To execute a single test file + + ```bash + pytest ./tests/unit_tests/test_file.py + ``` + +### Local Manual Testing + +Create this file in the root directory of the project: + +```python +from datacrunch.datacrunch import DataCrunchClient + +CLIENT_SECRET = 'secret' +CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi' + +# Create datcrunch client +datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET, base_url='http://localhost:3001/v1') +``` + +### Generating the documentation + +If added a new service, create a documentation template under api/services for that service. + +```bash +cd docs +make html +``` + +### Style Guide + +Use autopep8 for auto code formatting: + +```bash +# Install +pip3 install autopep8 + +# Apply to an entire directory +autopep8 directory_name --recursive --in-place --pep8-passes 2000 --verbose + +# Or a single file +autopep8 file.py --in-place +``` + +## Contact + +You can [contact us here](https://datacrunch.io/contact/), or send a message / open an issue in the repo. + + +%package -n python3-datacrunch +Summary: Official Python SDK for DataCrunch Public API +Provides: python-datacrunch +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-datacrunch +# DataCrunch Python SDK + +<p> + <a href='https://github.com/DataCrunch-io/datacrunch-python/actions?query=workflow%3A%22Unit+Tests%22+branch%3Amaster'> + <img src='https://github.com/DataCrunch-io/datacrunch-python/workflows/Unit%20Tests/badge.svg'></img> + </a> + + <a href='https://github.com/DataCrunch-io/datacrunch-python/actions?query=workflow%3A%22Code+Style%22+branch%3Amaster'> + <img src='https://github.com/DataCrunch-io/datacrunch-python/workflows/Code%20Style/badge.svg'></img> + </a> + + <a href="https://codecov.io/gh/DataCrunch-io/datacrunch-python"> + <img src="https://codecov.io/gh/DataCrunch-io/datacrunch-python/branch/master/graph/badge.svg?token=5X5KTYSSPK"/> + </a> + + <a href='https://datacrunch-python.readthedocs.io/en/latest/'> + <img src='https://readthedocs.org/projects/datacrunch-python/badge/?version=latest'></img> + </a> + + <a href='https://github.com/DataCrunch-io/datacrunch-python/blob/master/LICENSE'> + <img src='https://img.shields.io/github/license/DataCrunch-io/datacrunch-python'></img> + </a> + + <a href='https://pypi.org/project/datacrunch/'> + <img src='https://img.shields.io/pypi/v/datacrunch?logo=python'></img> + </a> + + <a href='https://pypi.org/project/datacrunch/'> + <img src='https://img.shields.io/pypi/pyversions/datacrunch'></img> + </a> +</p> + +The official [DataCrunch.io](https://datacrunch.io) Python SDK. + +The SDK's documentation is available on [ReadTheDocs](https://datacrunch-python.readthedocs.io/en/latest/) + +DataCrunch's Public API documentation [is available here](https://datacrunch.stoplight.io/docs/datacrunch-public/docs/Overview/Introduction.md). + +## Getting Started - Using the SDK: + +- Install via pip: + + ```bash + pip3 install datacrunch + ``` + +- Generate your client credentials - [instructions in the public API docs](https://datacrunch.stoplight.io/docs/datacrunch-public/docs/Overview/Quick-Start-Guide.md). + +- Add the client secret to an environment variable (don't want it to be hardcoded): + + Linux (bash): + + ```bash + export DATACRUNCH_CLIENT_SECRET=Z4CZq02rdwdB7ISV0k4Z2gtwAFKiyvr2U1l0KDIeYi + ``` + + Other platforms: + https://en.wikipedia.org/wiki/Environment_variable + +- Example for creating a new instance: + + ```python + import os + from datacrunch import DataCrunchClient + + # Get client secret from environment variable + CLIENT_SECRET = os.environ['DATACRUNCH_CLIENT_SECRET'] + CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi' + + # Create datcrunch client + datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET) + + # Get all SSH keys + ssh_keys = datacrunch.ssh_keys.get() + ssh_keys = list(map(lambda key: key.id, ssh_keys)) + + # Create a new instance + instance = datacrunch.instances.create(instance_type='1V100.6V', + image='fastai', + ssh_key_ids=ssh_keys, + hostname='example', + description='example instance') + + # Delete instance + datacrunch.instances.action(instance.id, datacrunch.constants.instance_actions.DELETE) + ``` + + More examples can be found in the `/examples` folder or in the [documentation](https://datacrunch-python.readthedocs.io/en/latest/). + +## Development + +### Setting up the local development environment + +- Clone the repository: + + ```bash + git clone + ``` + +- Create local virtual environment: + + ```bash + python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate + ``` + + or if using [fish shell](https://fishshell.com/): + + ```fish + python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate.fish + ``` + +- Install Dependencies: + + ```bash + pip3 install -e .[test] + pip3 install -U pytest + ``` + +### Running Tests + +We use pytest for testing. + +- To execute all tests + + ```bash + pytest + ``` + +- To execute a single test file + + ```bash + pytest ./tests/unit_tests/test_file.py + ``` + +### Local Manual Testing + +Create this file in the root directory of the project: + +```python +from datacrunch.datacrunch import DataCrunchClient + +CLIENT_SECRET = 'secret' +CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi' + +# Create datcrunch client +datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET, base_url='http://localhost:3001/v1') +``` + +### Generating the documentation + +If added a new service, create a documentation template under api/services for that service. + +```bash +cd docs +make html +``` + +### Style Guide + +Use autopep8 for auto code formatting: + +```bash +# Install +pip3 install autopep8 + +# Apply to an entire directory +autopep8 directory_name --recursive --in-place --pep8-passes 2000 --verbose + +# Or a single file +autopep8 file.py --in-place +``` + +## Contact + +You can [contact us here](https://datacrunch.io/contact/), or send a message / open an issue in the repo. + + +%package help +Summary: Development documents and examples for datacrunch +Provides: python3-datacrunch-doc +%description help +# DataCrunch Python SDK + +<p> + <a href='https://github.com/DataCrunch-io/datacrunch-python/actions?query=workflow%3A%22Unit+Tests%22+branch%3Amaster'> + <img src='https://github.com/DataCrunch-io/datacrunch-python/workflows/Unit%20Tests/badge.svg'></img> + </a> + + <a href='https://github.com/DataCrunch-io/datacrunch-python/actions?query=workflow%3A%22Code+Style%22+branch%3Amaster'> + <img src='https://github.com/DataCrunch-io/datacrunch-python/workflows/Code%20Style/badge.svg'></img> + </a> + + <a href="https://codecov.io/gh/DataCrunch-io/datacrunch-python"> + <img src="https://codecov.io/gh/DataCrunch-io/datacrunch-python/branch/master/graph/badge.svg?token=5X5KTYSSPK"/> + </a> + + <a href='https://datacrunch-python.readthedocs.io/en/latest/'> + <img src='https://readthedocs.org/projects/datacrunch-python/badge/?version=latest'></img> + </a> + + <a href='https://github.com/DataCrunch-io/datacrunch-python/blob/master/LICENSE'> + <img src='https://img.shields.io/github/license/DataCrunch-io/datacrunch-python'></img> + </a> + + <a href='https://pypi.org/project/datacrunch/'> + <img src='https://img.shields.io/pypi/v/datacrunch?logo=python'></img> + </a> + + <a href='https://pypi.org/project/datacrunch/'> + <img src='https://img.shields.io/pypi/pyversions/datacrunch'></img> + </a> +</p> + +The official [DataCrunch.io](https://datacrunch.io) Python SDK. + +The SDK's documentation is available on [ReadTheDocs](https://datacrunch-python.readthedocs.io/en/latest/) + +DataCrunch's Public API documentation [is available here](https://datacrunch.stoplight.io/docs/datacrunch-public/docs/Overview/Introduction.md). + +## Getting Started - Using the SDK: + +- Install via pip: + + ```bash + pip3 install datacrunch + ``` + +- Generate your client credentials - [instructions in the public API docs](https://datacrunch.stoplight.io/docs/datacrunch-public/docs/Overview/Quick-Start-Guide.md). + +- Add the client secret to an environment variable (don't want it to be hardcoded): + + Linux (bash): + + ```bash + export DATACRUNCH_CLIENT_SECRET=Z4CZq02rdwdB7ISV0k4Z2gtwAFKiyvr2U1l0KDIeYi + ``` + + Other platforms: + https://en.wikipedia.org/wiki/Environment_variable + +- Example for creating a new instance: + + ```python + import os + from datacrunch import DataCrunchClient + + # Get client secret from environment variable + CLIENT_SECRET = os.environ['DATACRUNCH_CLIENT_SECRET'] + CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi' + + # Create datcrunch client + datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET) + + # Get all SSH keys + ssh_keys = datacrunch.ssh_keys.get() + ssh_keys = list(map(lambda key: key.id, ssh_keys)) + + # Create a new instance + instance = datacrunch.instances.create(instance_type='1V100.6V', + image='fastai', + ssh_key_ids=ssh_keys, + hostname='example', + description='example instance') + + # Delete instance + datacrunch.instances.action(instance.id, datacrunch.constants.instance_actions.DELETE) + ``` + + More examples can be found in the `/examples` folder or in the [documentation](https://datacrunch-python.readthedocs.io/en/latest/). + +## Development + +### Setting up the local development environment + +- Clone the repository: + + ```bash + git clone + ``` + +- Create local virtual environment: + + ```bash + python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate + ``` + + or if using [fish shell](https://fishshell.com/): + + ```fish + python3 -m venv datacrunch_env && source ./datacrunch_env/bin/activate.fish + ``` + +- Install Dependencies: + + ```bash + pip3 install -e .[test] + pip3 install -U pytest + ``` + +### Running Tests + +We use pytest for testing. + +- To execute all tests + + ```bash + pytest + ``` + +- To execute a single test file + + ```bash + pytest ./tests/unit_tests/test_file.py + ``` + +### Local Manual Testing + +Create this file in the root directory of the project: + +```python +from datacrunch.datacrunch import DataCrunchClient + +CLIENT_SECRET = 'secret' +CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi' + +# Create datcrunch client +datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET, base_url='http://localhost:3001/v1') +``` + +### Generating the documentation + +If added a new service, create a documentation template under api/services for that service. + +```bash +cd docs +make html +``` + +### Style Guide + +Use autopep8 for auto code formatting: + +```bash +# Install +pip3 install autopep8 + +# Apply to an entire directory +autopep8 directory_name --recursive --in-place --pep8-passes 2000 --verbose + +# Or a single file +autopep8 file.py --in-place +``` + +## Contact + +You can [contact us here](https://datacrunch.io/contact/), or send a message / open an issue in the repo. + + +%prep +%autosetup -n datacrunch-1.4.0 + +%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-datacrunch -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 1.4.0-1 +- Package Spec generated |