summaryrefslogtreecommitdiff
path: root/python-pandablob.spec
blob: fa029f39722b44b862863ec7ef93749d698e008c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
%global _empty_manifest_terminate_build 0
Name:		python-pandablob
Version:	0.0.5
Release:	1
Summary:	Functions to easily transform Azure blobs into pandas DataFrames and vice versa.
License:	MIT
URL:		https://github.com/uijl/pandablob
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/44/b4/f0652652709c410ce3039df278757f807d01897db47a1b3e1cb915634872/pandablob-0.0.5a.tar.gz
BuildArch:	noarch


%description
![PyTest](https://github.com/uijl/pandablob/workflows/PyTest/badge.svg)
[![PyPI Latest Release](https://img.shields.io/pypi/v/pandablob.svg)](https://pypi.org/project/pandablob/)
[![Downloads](https://pepy.tech/badge/pandablob)](https://pepy.tech/project/pandablob)

# PandaBlob

Functions to easily transform Azure blobs into pandas DataFrames and vice versa. 

## Installation

Installing PandaBlob via [pip](https://pip.pypa.io) is the preferred method, as it will always install the most recent stable release. If you do not have
[pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.

To install PandaBlob, run this command in your terminal:

```bash
# Use pip to install PandaBlob
pip install pandablob
```

Downloading and installing PandaBlob from source is also possible, follow the code below.

```bash
# Download the package
git clone https://github.com/uijl/pandablob

# Go to the correct folder
cd pandablob

# Install package
pip install -e .
```

## Usage

The code snip below shows how you can use PandaBlob, all you need is a _[BlobClient](https://docs.microsoft.com/nl-nl/python/api/azure-storage-blob/azure.storage.blob.blobclient?view=azure-python)_ and possibly a pandas DataFrame or some keyword arguments for pandas.

```python
# Import the Azure SDK and pandablob
import pandablob

from azure.storage.blob import ContainerClient

# Your Azure Credentials
account_url = "https://my_account_url.blob.core.windows.net/"
token = "your_key_string"
container = "your_container"
blobname = "your_blob_name.csv"

container_client = ContainerClient(account_url, container, credential=token)
blob_client = container_client.get_blob_client(blob=blobname)

# Specifiy your pandas keyword arguments
pandas_kwargs = {"index_col": 0}

# Read the blob as a pandas DataFrame
df = pandablob.blob_to_df(blob_client, pandas_kwargs)
```

## Potential errors

There are three common errors that can be returned. Two are related to the blob storage and one because of the current limitations of pandablob.

- **ResourceExistsError** - If the specified blob is already on the blob, this error is returned. There are two options, you can add the `overwrite=True` argument to your `df_to_blob` function or you can catch the exception. If you wish to enter it in an except statement, you can import it using `from azure.core.exceptions import ResourceExistsError`;
- **ResourceNotFoundError** - If the specified blob is not found, this error is returned. If you wish to enter it in an except statement, you can import it using `from azure.core.exceptions import ResourceNotFoundError`;
- **TypeError** - This error is returned by pandablob if you want to upload or download an extensiontype that is not yet supported. Currently only the following extensions are supported: `.csv` `.json` `.txt`, `.xls` and `.xlsx`.

## To do list:

Some other stuff that needs to be done:

- [ ] Include other files;
- [x] Easier downloading a .csv file;
- [x] Added MIT license.

%package -n python3-pandablob
Summary:	Functions to easily transform Azure blobs into pandas DataFrames and vice versa.
Provides:	python-pandablob
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-pandablob
![PyTest](https://github.com/uijl/pandablob/workflows/PyTest/badge.svg)
[![PyPI Latest Release](https://img.shields.io/pypi/v/pandablob.svg)](https://pypi.org/project/pandablob/)
[![Downloads](https://pepy.tech/badge/pandablob)](https://pepy.tech/project/pandablob)

# PandaBlob

Functions to easily transform Azure blobs into pandas DataFrames and vice versa. 

## Installation

Installing PandaBlob via [pip](https://pip.pypa.io) is the preferred method, as it will always install the most recent stable release. If you do not have
[pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.

To install PandaBlob, run this command in your terminal:

```bash
# Use pip to install PandaBlob
pip install pandablob
```

Downloading and installing PandaBlob from source is also possible, follow the code below.

```bash
# Download the package
git clone https://github.com/uijl/pandablob

# Go to the correct folder
cd pandablob

# Install package
pip install -e .
```

## Usage

The code snip below shows how you can use PandaBlob, all you need is a _[BlobClient](https://docs.microsoft.com/nl-nl/python/api/azure-storage-blob/azure.storage.blob.blobclient?view=azure-python)_ and possibly a pandas DataFrame or some keyword arguments for pandas.

```python
# Import the Azure SDK and pandablob
import pandablob

from azure.storage.blob import ContainerClient

# Your Azure Credentials
account_url = "https://my_account_url.blob.core.windows.net/"
token = "your_key_string"
container = "your_container"
blobname = "your_blob_name.csv"

container_client = ContainerClient(account_url, container, credential=token)
blob_client = container_client.get_blob_client(blob=blobname)

# Specifiy your pandas keyword arguments
pandas_kwargs = {"index_col": 0}

# Read the blob as a pandas DataFrame
df = pandablob.blob_to_df(blob_client, pandas_kwargs)
```

## Potential errors

There are three common errors that can be returned. Two are related to the blob storage and one because of the current limitations of pandablob.

- **ResourceExistsError** - If the specified blob is already on the blob, this error is returned. There are two options, you can add the `overwrite=True` argument to your `df_to_blob` function or you can catch the exception. If you wish to enter it in an except statement, you can import it using `from azure.core.exceptions import ResourceExistsError`;
- **ResourceNotFoundError** - If the specified blob is not found, this error is returned. If you wish to enter it in an except statement, you can import it using `from azure.core.exceptions import ResourceNotFoundError`;
- **TypeError** - This error is returned by pandablob if you want to upload or download an extensiontype that is not yet supported. Currently only the following extensions are supported: `.csv` `.json` `.txt`, `.xls` and `.xlsx`.

## To do list:

Some other stuff that needs to be done:

- [ ] Include other files;
- [x] Easier downloading a .csv file;
- [x] Added MIT license.

%package help
Summary:	Development documents and examples for pandablob
Provides:	python3-pandablob-doc
%description help
![PyTest](https://github.com/uijl/pandablob/workflows/PyTest/badge.svg)
[![PyPI Latest Release](https://img.shields.io/pypi/v/pandablob.svg)](https://pypi.org/project/pandablob/)
[![Downloads](https://pepy.tech/badge/pandablob)](https://pepy.tech/project/pandablob)

# PandaBlob

Functions to easily transform Azure blobs into pandas DataFrames and vice versa. 

## Installation

Installing PandaBlob via [pip](https://pip.pypa.io) is the preferred method, as it will always install the most recent stable release. If you do not have
[pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.

To install PandaBlob, run this command in your terminal:

```bash
# Use pip to install PandaBlob
pip install pandablob
```

Downloading and installing PandaBlob from source is also possible, follow the code below.

```bash
# Download the package
git clone https://github.com/uijl/pandablob

# Go to the correct folder
cd pandablob

# Install package
pip install -e .
```

## Usage

The code snip below shows how you can use PandaBlob, all you need is a _[BlobClient](https://docs.microsoft.com/nl-nl/python/api/azure-storage-blob/azure.storage.blob.blobclient?view=azure-python)_ and possibly a pandas DataFrame or some keyword arguments for pandas.

```python
# Import the Azure SDK and pandablob
import pandablob

from azure.storage.blob import ContainerClient

# Your Azure Credentials
account_url = "https://my_account_url.blob.core.windows.net/"
token = "your_key_string"
container = "your_container"
blobname = "your_blob_name.csv"

container_client = ContainerClient(account_url, container, credential=token)
blob_client = container_client.get_blob_client(blob=blobname)

# Specifiy your pandas keyword arguments
pandas_kwargs = {"index_col": 0}

# Read the blob as a pandas DataFrame
df = pandablob.blob_to_df(blob_client, pandas_kwargs)
```

## Potential errors

There are three common errors that can be returned. Two are related to the blob storage and one because of the current limitations of pandablob.

- **ResourceExistsError** - If the specified blob is already on the blob, this error is returned. There are two options, you can add the `overwrite=True` argument to your `df_to_blob` function or you can catch the exception. If you wish to enter it in an except statement, you can import it using `from azure.core.exceptions import ResourceExistsError`;
- **ResourceNotFoundError** - If the specified blob is not found, this error is returned. If you wish to enter it in an except statement, you can import it using `from azure.core.exceptions import ResourceNotFoundError`;
- **TypeError** - This error is returned by pandablob if you want to upload or download an extensiontype that is not yet supported. Currently only the following extensions are supported: `.csv` `.json` `.txt`, `.xls` and `.xlsx`.

## To do list:

Some other stuff that needs to be done:

- [ ] Include other files;
- [x] Easier downloading a .csv file;
- [x] Added MIT license.

%prep
%autosetup -n pandablob-0.0.5

%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-pandablob -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.5-1
- Package Spec generated