summaryrefslogtreecommitdiff
path: root/python-encapsia-api.spec
blob: 219e24be66b3db0e1ce9852b4f58bd8af78e5d77 (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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
%global _empty_manifest_terminate_build 0
Name:		python-encapsia-api
Version:	0.4.2
Release:	1
Summary:	Client API for talking to an Encapsia system.
License:	MIT
URL:		https://github.com/Encapsia/encapsia-api
Source0:	https://mirrors.aliyun.com/pypi/web/packages/3a/85/bc0ca1f4ca2a7f773849b0d0b8cf2306ba2d599aac0cae3dadcb9effbfd9/encapsia_api-0.4.2.tar.gz
BuildArch:	noarch

Requires:	python3-requests[security]
Requires:	python3-toml
Requires:	python3-arrow

%description
# Encapsia API Library

![Workflows](https://github.com/encapsia/encapsia-api/actions/workflows/main.yml/badge.svg)
![PyPI](https://img.shields.io/pypi/v/encapsia-api?style=flat)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/encapsia-api)

[![Known Vulnerabilities](https://snyk.io/test/github/encapsia/encapsia-api/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/encapsia/encapsia-api?targetFile=requirements.txt)


REST API for working with [Encapsia](https://www.encapsia.com).

## Installation

   pip install encapsia-api
   

## Contributing

`encapsia-api` is a python package managed with [`poetry`](https://python-poetry.org/).
You will need python 3.8 or newer. To get started, after checking out this repository,
run:

    poetry install
    

### Code Style

Code in this project should be auto-formatted using `black` and adhere to isort-like
imports, and should pass linting and checks. You can run the following commands
manually, or integrate the tooling in your dev environment, but see also the next
section.

    poetry run black .
    poetry run ruff check .
    poetry run mypy .

Ruff can fix some of the issues it finds. For example, it can fix the style of importing
modules, but it can do much more. This can be done with running:

    poetry run ruff check --fix .
    
However, please make sure you check the fixes it performs!


### Revision Control

The release branch for this project is `master` and feature branches should be merged
into it via pull requests.

This repository uses [`pre-commit`](https://pre-commit.com/) to run various checks with
git pre-commit hooks. To get started, run:

    pre-commit install
   
After this, configured checks are run before you commit changes. You can also run them
explicitly for all files:

    pre-commit run -a


### Versioning

`encapsia-api` adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

To change the version, run:

    poetry version <specifier>   # e.g. patch

or edit the version string in `pyproject.toml`. In any case, update the following file
to match the new version: `encapsia_api/__init__.py`.

Note that we are yet in `<1.0.0` land and thus version changes are not too strict and
backward-incompatible changes may still occur before 1.0.0.


### Building

Manually build by running:

    poetry build
    
    
### Updating Dependencies

This is achieved with:

    poetry update
    poetry lock
    poetry export -f requirements.txt > requirements.txt

### How to Run Tests

Run:

    poetry run pytest


### Continuous Integration

This project uses Github Actions to for linting, checking, and running the tests on
commit to or pull requests targeting the main branch.


%package -n python3-encapsia-api
Summary:	Client API for talking to an Encapsia system.
Provides:	python-encapsia-api
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-encapsia-api
# Encapsia API Library

![Workflows](https://github.com/encapsia/encapsia-api/actions/workflows/main.yml/badge.svg)
![PyPI](https://img.shields.io/pypi/v/encapsia-api?style=flat)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/encapsia-api)

[![Known Vulnerabilities](https://snyk.io/test/github/encapsia/encapsia-api/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/encapsia/encapsia-api?targetFile=requirements.txt)


REST API for working with [Encapsia](https://www.encapsia.com).

## Installation

   pip install encapsia-api
   

## Contributing

`encapsia-api` is a python package managed with [`poetry`](https://python-poetry.org/).
You will need python 3.8 or newer. To get started, after checking out this repository,
run:

    poetry install
    

### Code Style

Code in this project should be auto-formatted using `black` and adhere to isort-like
imports, and should pass linting and checks. You can run the following commands
manually, or integrate the tooling in your dev environment, but see also the next
section.

    poetry run black .
    poetry run ruff check .
    poetry run mypy .

Ruff can fix some of the issues it finds. For example, it can fix the style of importing
modules, but it can do much more. This can be done with running:

    poetry run ruff check --fix .
    
However, please make sure you check the fixes it performs!


### Revision Control

The release branch for this project is `master` and feature branches should be merged
into it via pull requests.

This repository uses [`pre-commit`](https://pre-commit.com/) to run various checks with
git pre-commit hooks. To get started, run:

    pre-commit install
   
After this, configured checks are run before you commit changes. You can also run them
explicitly for all files:

    pre-commit run -a


### Versioning

`encapsia-api` adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

To change the version, run:

    poetry version <specifier>   # e.g. patch

or edit the version string in `pyproject.toml`. In any case, update the following file
to match the new version: `encapsia_api/__init__.py`.

Note that we are yet in `<1.0.0` land and thus version changes are not too strict and
backward-incompatible changes may still occur before 1.0.0.


### Building

Manually build by running:

    poetry build
    
    
### Updating Dependencies

This is achieved with:

    poetry update
    poetry lock
    poetry export -f requirements.txt > requirements.txt

### How to Run Tests

Run:

    poetry run pytest


### Continuous Integration

This project uses Github Actions to for linting, checking, and running the tests on
commit to or pull requests targeting the main branch.


%package help
Summary:	Development documents and examples for encapsia-api
Provides:	python3-encapsia-api-doc
%description help
# Encapsia API Library

![Workflows](https://github.com/encapsia/encapsia-api/actions/workflows/main.yml/badge.svg)
![PyPI](https://img.shields.io/pypi/v/encapsia-api?style=flat)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/encapsia-api)

[![Known Vulnerabilities](https://snyk.io/test/github/encapsia/encapsia-api/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/encapsia/encapsia-api?targetFile=requirements.txt)


REST API for working with [Encapsia](https://www.encapsia.com).

## Installation

   pip install encapsia-api
   

## Contributing

`encapsia-api` is a python package managed with [`poetry`](https://python-poetry.org/).
You will need python 3.8 or newer. To get started, after checking out this repository,
run:

    poetry install
    

### Code Style

Code in this project should be auto-formatted using `black` and adhere to isort-like
imports, and should pass linting and checks. You can run the following commands
manually, or integrate the tooling in your dev environment, but see also the next
section.

    poetry run black .
    poetry run ruff check .
    poetry run mypy .

Ruff can fix some of the issues it finds. For example, it can fix the style of importing
modules, but it can do much more. This can be done with running:

    poetry run ruff check --fix .
    
However, please make sure you check the fixes it performs!


### Revision Control

The release branch for this project is `master` and feature branches should be merged
into it via pull requests.

This repository uses [`pre-commit`](https://pre-commit.com/) to run various checks with
git pre-commit hooks. To get started, run:

    pre-commit install
   
After this, configured checks are run before you commit changes. You can also run them
explicitly for all files:

    pre-commit run -a


### Versioning

`encapsia-api` adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

To change the version, run:

    poetry version <specifier>   # e.g. patch

or edit the version string in `pyproject.toml`. In any case, update the following file
to match the new version: `encapsia_api/__init__.py`.

Note that we are yet in `<1.0.0` land and thus version changes are not too strict and
backward-incompatible changes may still occur before 1.0.0.


### Building

Manually build by running:

    poetry build
    
    
### Updating Dependencies

This is achieved with:

    poetry update
    poetry lock
    poetry export -f requirements.txt > requirements.txt

### How to Run Tests

Run:

    poetry run pytest


### Continuous Integration

This project uses Github Actions to for linting, checking, and running the tests on
commit to or pull requests targeting the main branch.


%prep
%autosetup -n encapsia_api-0.4.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-encapsia-api -f filelist.lst
%dir %{python3_sitelib}/*

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

%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.2-1
- Package Spec generated