automatic import of python-crux

1 files changed, 511 insertions, 0 deletions

diff --git a/python-crux.spec b/python-crux.spec
new file mode 100644
index 0000000..a9b515c
--- /dev/null
+++ b/python-crux.spec
@@ -0,0 +1,511 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-crux
+Version:	1.2
+Release:	1
+Summary:	Crux Informatics API client library
+License:	MIT
+URL:		https://github.com/cruxinformatics/crux-python
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/bf/11/b0ecc5db2c5c4e17bfcdfa62b9468eefc34350608d576433e23fb33a90ce/crux-1.2.tar.gz
+BuildArch:	noarch
+
+Requires:	python3-google-resumable-media[requests]
+Requires:	python3-dateutil
+Requires:	python3-enum34
+Requires:	python3-typing
+
+%description
+# Crux Python Client
+
+A Python library for interacting with the Crux platform.
+
+The aim of this module is to be a Pythonic way to use the Crux API reliably. It covers client functionality including scanning subscriptions, getting delivery status, and downloading files.
+
+Python 3.6+ is supported.
+
+**See [crux-python.cruxinformatics.com](https://crux-python.cruxinformatics.com/) for detailed documentation.**
+
+## Installation
+
+Install a recent version of Python, and a Python dependency and virtual environment manager like [pipenv](https://pipenv.readthedocs.io/en/latest/). On macOS run:
+
+```bash
+brew install python
+brew install pipenv
+```
+
+Install `crux` [from PyPI](https://pypi.org/project/crux/) in a virtual environment, and get a shell in that environment:
+
+```bash
+mkdir -p crux_example
+cd crux_example
+pipenv install "crux==1.2"
+pipenv shell
+```
+## Getting Started
+
+Create a file, like example.py, and use the `crux` module:
+
+```python
+from crux import Crux
+
+conn = Crux()
+identity = conn.whoami()
+print("I am", identity.email)
+```
+
+Run the script:
+
+```bash
+HISTCONTROL=ignoreboth
+ export CRUX_API_KEY='YOUR_API_KEY'
+python3 example.py
+```
+
+See the [installation](https://crux-python.cruxinformatics.com/en/latest/installation.html) and [authentication](https://crux-python.cruxinformatics.com/en/latest/authentication.html) documentation for details.
+
+## Development
+
+Python 3.7 is required for development, which can be installed with `brew install python`. For heavy development work, every supported version of Python must be installed, see the pyenv documentation below.
+
+[Pipenv](https://pipenv.readthedocs.io/en/latest/) should be used to manage dependancies during development.
+
+1. [Install Pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv), on macOS run `brew install pipenv`
+2. `git clone https://github.com/cruxinformatics/crux-python.git`
+3. `cd crux-python`
+4. `pipenv install --dev` to install the dependancies
+5. `pipenv shell` to get a shell in the virtual environment
+
+### Multiple Python versions
+
+To be able to run tests against all supported Python versions, you must have all supported Python versions installed. The test runner will look for binaries called `python2.7`, `python3.5`, `python3.6`, etc. There are multiple ways to install Python versions, we'll document using [pyenv](https://github.com/pyenv/pyenv).
+
+1. `brew install pyenv` to install
+2. Put `eval "$(pyenv init -)"` towards the end of the shell configuration file (~/.bashrc or ~/.bash_profile), because it manipulates `$PATH`, for example:
+
+    ```bash
+    echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n  eval "$(pyenv init -)"\nfi' >> ~/.bashrc
+    ```
+
+3. Open a new Terminal to get an updated shell
+4. Install required/missing Python versions (this assumes you have Python 2.7 already installed, otherwise install it too):
+
+    ```bash
+    pyenv install 3.5.6
+    pyenv install 3.6.6
+    pyenv install 3.7.0
+    ```
+
+5. `pyenv global system 3.5.6 3.6.6 3.7.0` to make all the Python versions available
+6. If you already have pipenv virtual environment, remove it with `pipenv --rm` so it detects the Python versions
+7. `pipenv install --dev` to install all the dependancies
+8. `pipenv shell` to get a shell in the virtual environment
+
+### Running tests
+
+We use [Nox](https://nox.thea.codes/en/stable/) to automate running tests, and use `make` to automate running some commands. These commands should be run within a shell created with `pipenv shell`.
+
+```bash
+# Run all tests: lint, unit, format_check
+make test
+# Or
+nox
+
+# Run only lint checks
+make lint
+# Or
+nox -s lint
+
+# Run unit tests against all available Python versions
+make unit
+# Or
+nox -s unit
+
+# Run integration tests agains all available Python versions
+ export CRUX_API_KEY="12345"
+export CRUX_API_HOST="https://api.example.com"
+make integration
+# Or
+ export CRUX_API_KEY="12345"
+export CRUX_API_HOST="https://api.example.com"
+nox --s integration
+
+# Check formatting
+make format_check
+# Or
+nox -s format_check
+
+# List all commands available
+make
+# Or
+nox -l
+
+# Run unit test only against Python 3.7
+nox -s unit-3.7
+
+# Reformat code
+make format
+
+# Generate Sphinx HTML documentation
+make docs
+```
+
+#### Running test scripts
+
+Manual testing scripts could be found at `tests/regression`.
+In order to run one, i.e. `client.py`, follow the steps:
+
+1. copy corresponding `.env.dist` file as `.env` file (if you plan to run `client.py`, copy `client.env.dist` as `client.env`)
+2. fill variables within `.env` file
+3. launch the script (while being in the `tests/regression` folder, execute `python client.py`)
+
+
+
+
+%package -n python3-crux
+Summary:	Crux Informatics API client library
+Provides:	python-crux
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-crux
+# Crux Python Client
+
+A Python library for interacting with the Crux platform.
+
+The aim of this module is to be a Pythonic way to use the Crux API reliably. It covers client functionality including scanning subscriptions, getting delivery status, and downloading files.
+
+Python 3.6+ is supported.
+
+**See [crux-python.cruxinformatics.com](https://crux-python.cruxinformatics.com/) for detailed documentation.**
+
+## Installation
+
+Install a recent version of Python, and a Python dependency and virtual environment manager like [pipenv](https://pipenv.readthedocs.io/en/latest/). On macOS run:
+
+```bash
+brew install python
+brew install pipenv
+```
+
+Install `crux` [from PyPI](https://pypi.org/project/crux/) in a virtual environment, and get a shell in that environment:
+
+```bash
+mkdir -p crux_example
+cd crux_example
+pipenv install "crux==1.2"
+pipenv shell
+```
+## Getting Started
+
+Create a file, like example.py, and use the `crux` module:
+
+```python
+from crux import Crux
+
+conn = Crux()
+identity = conn.whoami()
+print("I am", identity.email)
+```
+
+Run the script:
+
+```bash
+HISTCONTROL=ignoreboth
+ export CRUX_API_KEY='YOUR_API_KEY'
+python3 example.py
+```
+
+See the [installation](https://crux-python.cruxinformatics.com/en/latest/installation.html) and [authentication](https://crux-python.cruxinformatics.com/en/latest/authentication.html) documentation for details.
+
+## Development
+
+Python 3.7 is required for development, which can be installed with `brew install python`. For heavy development work, every supported version of Python must be installed, see the pyenv documentation below.
+
+[Pipenv](https://pipenv.readthedocs.io/en/latest/) should be used to manage dependancies during development.
+
+1. [Install Pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv), on macOS run `brew install pipenv`
+2. `git clone https://github.com/cruxinformatics/crux-python.git`
+3. `cd crux-python`
+4. `pipenv install --dev` to install the dependancies
+5. `pipenv shell` to get a shell in the virtual environment
+
+### Multiple Python versions
+
+To be able to run tests against all supported Python versions, you must have all supported Python versions installed. The test runner will look for binaries called `python2.7`, `python3.5`, `python3.6`, etc. There are multiple ways to install Python versions, we'll document using [pyenv](https://github.com/pyenv/pyenv).
+
+1. `brew install pyenv` to install
+2. Put `eval "$(pyenv init -)"` towards the end of the shell configuration file (~/.bashrc or ~/.bash_profile), because it manipulates `$PATH`, for example:
+
+    ```bash
+    echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n  eval "$(pyenv init -)"\nfi' >> ~/.bashrc
+    ```
+
+3. Open a new Terminal to get an updated shell
+4. Install required/missing Python versions (this assumes you have Python 2.7 already installed, otherwise install it too):
+
+    ```bash
+    pyenv install 3.5.6
+    pyenv install 3.6.6
+    pyenv install 3.7.0
+    ```
+
+5. `pyenv global system 3.5.6 3.6.6 3.7.0` to make all the Python versions available
+6. If you already have pipenv virtual environment, remove it with `pipenv --rm` so it detects the Python versions
+7. `pipenv install --dev` to install all the dependancies
+8. `pipenv shell` to get a shell in the virtual environment
+
+### Running tests
+
+We use [Nox](https://nox.thea.codes/en/stable/) to automate running tests, and use `make` to automate running some commands. These commands should be run within a shell created with `pipenv shell`.
+
+```bash
+# Run all tests: lint, unit, format_check
+make test
+# Or
+nox
+
+# Run only lint checks
+make lint
+# Or
+nox -s lint
+
+# Run unit tests against all available Python versions
+make unit
+# Or
+nox -s unit
+
+# Run integration tests agains all available Python versions
+ export CRUX_API_KEY="12345"
+export CRUX_API_HOST="https://api.example.com"
+make integration
+# Or
+ export CRUX_API_KEY="12345"
+export CRUX_API_HOST="https://api.example.com"
+nox --s integration
+
+# Check formatting
+make format_check
+# Or
+nox -s format_check
+
+# List all commands available
+make
+# Or
+nox -l
+
+# Run unit test only against Python 3.7
+nox -s unit-3.7
+
+# Reformat code
+make format
+
+# Generate Sphinx HTML documentation
+make docs
+```
+
+#### Running test scripts
+
+Manual testing scripts could be found at `tests/regression`.
+In order to run one, i.e. `client.py`, follow the steps:
+
+1. copy corresponding `.env.dist` file as `.env` file (if you plan to run `client.py`, copy `client.env.dist` as `client.env`)
+2. fill variables within `.env` file
+3. launch the script (while being in the `tests/regression` folder, execute `python client.py`)
+
+
+
+
+%package help
+Summary:	Development documents and examples for crux
+Provides:	python3-crux-doc
+%description help
+# Crux Python Client
+
+A Python library for interacting with the Crux platform.
+
+The aim of this module is to be a Pythonic way to use the Crux API reliably. It covers client functionality including scanning subscriptions, getting delivery status, and downloading files.
+
+Python 3.6+ is supported.
+
+**See [crux-python.cruxinformatics.com](https://crux-python.cruxinformatics.com/) for detailed documentation.**
+
+## Installation
+
+Install a recent version of Python, and a Python dependency and virtual environment manager like [pipenv](https://pipenv.readthedocs.io/en/latest/). On macOS run:
+
+```bash
+brew install python
+brew install pipenv
+```
+
+Install `crux` [from PyPI](https://pypi.org/project/crux/) in a virtual environment, and get a shell in that environment:
+
+```bash
+mkdir -p crux_example
+cd crux_example
+pipenv install "crux==1.2"
+pipenv shell
+```
+## Getting Started
+
+Create a file, like example.py, and use the `crux` module:
+
+```python
+from crux import Crux
+
+conn = Crux()
+identity = conn.whoami()
+print("I am", identity.email)
+```
+
+Run the script:
+
+```bash
+HISTCONTROL=ignoreboth
+ export CRUX_API_KEY='YOUR_API_KEY'
+python3 example.py
+```
+
+See the [installation](https://crux-python.cruxinformatics.com/en/latest/installation.html) and [authentication](https://crux-python.cruxinformatics.com/en/latest/authentication.html) documentation for details.
+
+## Development
+
+Python 3.7 is required for development, which can be installed with `brew install python`. For heavy development work, every supported version of Python must be installed, see the pyenv documentation below.
+
+[Pipenv](https://pipenv.readthedocs.io/en/latest/) should be used to manage dependancies during development.
+
+1. [Install Pipenv](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv), on macOS run `brew install pipenv`
+2. `git clone https://github.com/cruxinformatics/crux-python.git`
+3. `cd crux-python`
+4. `pipenv install --dev` to install the dependancies
+5. `pipenv shell` to get a shell in the virtual environment
+
+### Multiple Python versions
+
+To be able to run tests against all supported Python versions, you must have all supported Python versions installed. The test runner will look for binaries called `python2.7`, `python3.5`, `python3.6`, etc. There are multiple ways to install Python versions, we'll document using [pyenv](https://github.com/pyenv/pyenv).
+
+1. `brew install pyenv` to install
+2. Put `eval "$(pyenv init -)"` towards the end of the shell configuration file (~/.bashrc or ~/.bash_profile), because it manipulates `$PATH`, for example:
+
+    ```bash
+    echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n  eval "$(pyenv init -)"\nfi' >> ~/.bashrc
+    ```
+
+3. Open a new Terminal to get an updated shell
+4. Install required/missing Python versions (this assumes you have Python 2.7 already installed, otherwise install it too):
+
+    ```bash
+    pyenv install 3.5.6
+    pyenv install 3.6.6
+    pyenv install 3.7.0
+    ```
+
+5. `pyenv global system 3.5.6 3.6.6 3.7.0` to make all the Python versions available
+6. If you already have pipenv virtual environment, remove it with `pipenv --rm` so it detects the Python versions
+7. `pipenv install --dev` to install all the dependancies
+8. `pipenv shell` to get a shell in the virtual environment
+
+### Running tests
+
+We use [Nox](https://nox.thea.codes/en/stable/) to automate running tests, and use `make` to automate running some commands. These commands should be run within a shell created with `pipenv shell`.
+
+```bash
+# Run all tests: lint, unit, format_check
+make test
+# Or
+nox
+
+# Run only lint checks
+make lint
+# Or
+nox -s lint
+
+# Run unit tests against all available Python versions
+make unit
+# Or
+nox -s unit
+
+# Run integration tests agains all available Python versions
+ export CRUX_API_KEY="12345"
+export CRUX_API_HOST="https://api.example.com"
+make integration
+# Or
+ export CRUX_API_KEY="12345"
+export CRUX_API_HOST="https://api.example.com"
+nox --s integration
+
+# Check formatting
+make format_check
+# Or
+nox -s format_check
+
+# List all commands available
+make
+# Or
+nox -l
+
+# Run unit test only against Python 3.7
+nox -s unit-3.7
+
+# Reformat code
+make format
+
+# Generate Sphinx HTML documentation
+make docs
+```
+
+#### Running test scripts
+
+Manual testing scripts could be found at `tests/regression`.
+In order to run one, i.e. `client.py`, follow the steps:
+
+1. copy corresponding `.env.dist` file as `.env` file (if you plan to run `client.py`, copy `client.env.dist` as `client.env`)
+2. fill variables within `.env` file
+3. launch the script (while being in the `tests/regression` folder, execute `python client.py`)
+
+
+
+
+%prep
+%autosetup -n crux-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-crux -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Wed May 17 2023 Python_Bot <Python_Bot@openeuler.org> - 1.2-1
+- Package Spec generated