summaryrefslogtreecommitdiff
path: root/python-cathpy.spec
blob: 4f5e767175b96d2d256e58b8faad5865036fe832 (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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
%global _empty_manifest_terminate_build 0
Name:		python-cathpy
Version:	0.4.1
Release:	1
Summary:	CathPy - Python Bioinformatics Toolkit for CATH (Protein Classification).
License:	MIT License
URL:		https://github.com/UCL/cathpy
Source0:	https://mirrors.aliyun.com/pypi/web/packages/17/a3/9e828da752ffbd1923502e6268eb66f6442b2572fcde722b06e933acef27/cathpy-0.4.1.tar.gz
BuildArch:	noarch

Requires:	python3-Click
Requires:	python3-requests
Requires:	python3-jsonpickle
Requires:	python3-tqdm
Requires:	python3-dendropy
Requires:	python3-redis
Requires:	python3-celery
Requires:	python3-pymongo

%description
# cathpy

[![Documentation Status](https://readthedocs.org/projects/cathpy/badge/?version=latest)](https://cathpy.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.com/UCL/cathpy.svg?branch=master)](https://travis-ci.com/UCL/cathpy)
[![codecov](https://codecov.io/gh/UCL/cathpy/branch/master/graph/badge.svg)](https://codecov.io/gh/UCL/cathpy)

`cathpy` is a Bioinformatics toolkit written in Python. It is developed and maintained by the
[Orengo Group](http://orengogroup.info/) at [UCL](https://www.ucl.ac.uk/orengo-group/) and is used for maintaining the [CATH protein structure database](http://www.cathdb.info) (and associated research).


## Getting Started

The easiest way to use this code is by installing the latest version into a virtual environment via `pip`:

```sh
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install cathpy
```

If everything is installed and working properly then the following should work:

```sh
$ cath-align-summary -d tests/data/funfams/
file aln_len seq_count dops gap_per
tests/data/funfams/1.10.8.10-ff-14534.reduced.sto                          69     51  61.53  12.53
tests/data/funfams/1.10.8.10-ff-15516.reduced.sto                          66    429 100.00  13.04
tests/data/funfams/1.10.8.10-ff-5069.reduced.sto                           59     14   7.81   3.15
tests/data/funfams/1.10.8.10-ff-15593.reduced.sto                          63    203  95.88  17.70
```

Now go and [have a look at the documentation](https://cathpy.readthedocs.io/en/latest/).

## Contributing

There are many ways to contribute, all of which are most welcome.

 * If something is not clear then you have identified a gap in the documentation, please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new) 
 * If it looks like you should be able to do something that you can't then you've either identified a new feature request or a documentation gap - please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new)
 * If you have noticed some unexpected behaviour, you may have found a bug - please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new)

When you do raise an issue, it is extremely helpful if you first check that a similar issue has not already been registered. It would also be great if you can be as clear, concise and specific as possible. If you are reporting a potential bug, please try to provide steps that will allow us to reproduce the unexpected behaviour.

If you accompany your issue with a Pull Request that actually solves the documentation / feature request / bug fix then you may well be eligible for doughnuts.

## Development

If you are developing, then this is the general recommended flow:

Get access to the latest version of the code and create a new branch (with a descriptive summary of your new feature/bugfix):

```sh
$ git clone git@github.com:UCL/cathpy.git
$ cd cathpy
$ git checkout -b my-awesome-new-feature
```

Install the code (as editable package) into virtual environment

```sh
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -e .
```

Write your tests, make your changes then make sure your tests (and all the other tests) still pass:

```sh
$ vim tests/my_new_feature_test.py
$ vim cathpy/my_new_feature.py
$ pytest
```

Then push your changes back to GitHub and raise a pull request through the web pages.

```sh
$ git push
```

## FAQ

**What is cathpy?**

`cathpy` is a python package that contains bioinformatics tools and libraries
used in [CATH](http://cathdb.info) (protein structure classification resource at UCL).

**Hmmm.. that sounds like Yet Another Python Bioinformatics Toolkit?**

Well it is... sort of.

**Should I be using it?**

If you are looking for a general Bioinformatics toolkit, you should look at [BioPython](https://biopython.org/) first.

The `cathpy` project does contain some generic functionality that may overlap with BioPython,
however we are definitely not trying to rewrite that library. It has been published mainly for 
internal use (within CATH), however it has been released as open source in case others find the tools helpful.

## External software

This code base contains external tools that are not written and maintained by the authors
of this project. If you use the results of these tools, please reference the relevant papers.

#### GroupSim

Characterization and Prediction of Residues Determining Protein Functional Specificity.
**Capra JA and Singh M (2008).**<br>
*Bioinformatics, 24(13): 1473-1480, 2008.*

#### Scorecons

Scoring residue conservation.
**Valdar WSJ (2002)**<br>
*Proteins: Structure, Function, and Genetics. 43(2): 227-241, 2002.*

## References

The most recent paper describing the CATH protein structure database:

CATH: expanding the horizons of structure-based functional annotations for genome sequences.
**Sillitoe I, et al (2018)**<br>
*Nucleic Acids Research, Volume 47, Issue D1, 08 January 2019, Pages D280–D284, https://doi.org/10.1093/nar/gky1097*





%package -n python3-cathpy
Summary:	CathPy - Python Bioinformatics Toolkit for CATH (Protein Classification).
Provides:	python-cathpy
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-cathpy
# cathpy

[![Documentation Status](https://readthedocs.org/projects/cathpy/badge/?version=latest)](https://cathpy.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.com/UCL/cathpy.svg?branch=master)](https://travis-ci.com/UCL/cathpy)
[![codecov](https://codecov.io/gh/UCL/cathpy/branch/master/graph/badge.svg)](https://codecov.io/gh/UCL/cathpy)

`cathpy` is a Bioinformatics toolkit written in Python. It is developed and maintained by the
[Orengo Group](http://orengogroup.info/) at [UCL](https://www.ucl.ac.uk/orengo-group/) and is used for maintaining the [CATH protein structure database](http://www.cathdb.info) (and associated research).


## Getting Started

The easiest way to use this code is by installing the latest version into a virtual environment via `pip`:

```sh
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install cathpy
```

If everything is installed and working properly then the following should work:

```sh
$ cath-align-summary -d tests/data/funfams/
file aln_len seq_count dops gap_per
tests/data/funfams/1.10.8.10-ff-14534.reduced.sto                          69     51  61.53  12.53
tests/data/funfams/1.10.8.10-ff-15516.reduced.sto                          66    429 100.00  13.04
tests/data/funfams/1.10.8.10-ff-5069.reduced.sto                           59     14   7.81   3.15
tests/data/funfams/1.10.8.10-ff-15593.reduced.sto                          63    203  95.88  17.70
```

Now go and [have a look at the documentation](https://cathpy.readthedocs.io/en/latest/).

## Contributing

There are many ways to contribute, all of which are most welcome.

 * If something is not clear then you have identified a gap in the documentation, please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new) 
 * If it looks like you should be able to do something that you can't then you've either identified a new feature request or a documentation gap - please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new)
 * If you have noticed some unexpected behaviour, you may have found a bug - please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new)

When you do raise an issue, it is extremely helpful if you first check that a similar issue has not already been registered. It would also be great if you can be as clear, concise and specific as possible. If you are reporting a potential bug, please try to provide steps that will allow us to reproduce the unexpected behaviour.

If you accompany your issue with a Pull Request that actually solves the documentation / feature request / bug fix then you may well be eligible for doughnuts.

## Development

If you are developing, then this is the general recommended flow:

Get access to the latest version of the code and create a new branch (with a descriptive summary of your new feature/bugfix):

```sh
$ git clone git@github.com:UCL/cathpy.git
$ cd cathpy
$ git checkout -b my-awesome-new-feature
```

Install the code (as editable package) into virtual environment

```sh
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -e .
```

Write your tests, make your changes then make sure your tests (and all the other tests) still pass:

```sh
$ vim tests/my_new_feature_test.py
$ vim cathpy/my_new_feature.py
$ pytest
```

Then push your changes back to GitHub and raise a pull request through the web pages.

```sh
$ git push
```

## FAQ

**What is cathpy?**

`cathpy` is a python package that contains bioinformatics tools and libraries
used in [CATH](http://cathdb.info) (protein structure classification resource at UCL).

**Hmmm.. that sounds like Yet Another Python Bioinformatics Toolkit?**

Well it is... sort of.

**Should I be using it?**

If you are looking for a general Bioinformatics toolkit, you should look at [BioPython](https://biopython.org/) first.

The `cathpy` project does contain some generic functionality that may overlap with BioPython,
however we are definitely not trying to rewrite that library. It has been published mainly for 
internal use (within CATH), however it has been released as open source in case others find the tools helpful.

## External software

This code base contains external tools that are not written and maintained by the authors
of this project. If you use the results of these tools, please reference the relevant papers.

#### GroupSim

Characterization and Prediction of Residues Determining Protein Functional Specificity.
**Capra JA and Singh M (2008).**<br>
*Bioinformatics, 24(13): 1473-1480, 2008.*

#### Scorecons

Scoring residue conservation.
**Valdar WSJ (2002)**<br>
*Proteins: Structure, Function, and Genetics. 43(2): 227-241, 2002.*

## References

The most recent paper describing the CATH protein structure database:

CATH: expanding the horizons of structure-based functional annotations for genome sequences.
**Sillitoe I, et al (2018)**<br>
*Nucleic Acids Research, Volume 47, Issue D1, 08 January 2019, Pages D280–D284, https://doi.org/10.1093/nar/gky1097*





%package help
Summary:	Development documents and examples for cathpy
Provides:	python3-cathpy-doc
%description help
# cathpy

[![Documentation Status](https://readthedocs.org/projects/cathpy/badge/?version=latest)](https://cathpy.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.com/UCL/cathpy.svg?branch=master)](https://travis-ci.com/UCL/cathpy)
[![codecov](https://codecov.io/gh/UCL/cathpy/branch/master/graph/badge.svg)](https://codecov.io/gh/UCL/cathpy)

`cathpy` is a Bioinformatics toolkit written in Python. It is developed and maintained by the
[Orengo Group](http://orengogroup.info/) at [UCL](https://www.ucl.ac.uk/orengo-group/) and is used for maintaining the [CATH protein structure database](http://www.cathdb.info) (and associated research).


## Getting Started

The easiest way to use this code is by installing the latest version into a virtual environment via `pip`:

```sh
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install cathpy
```

If everything is installed and working properly then the following should work:

```sh
$ cath-align-summary -d tests/data/funfams/
file aln_len seq_count dops gap_per
tests/data/funfams/1.10.8.10-ff-14534.reduced.sto                          69     51  61.53  12.53
tests/data/funfams/1.10.8.10-ff-15516.reduced.sto                          66    429 100.00  13.04
tests/data/funfams/1.10.8.10-ff-5069.reduced.sto                           59     14   7.81   3.15
tests/data/funfams/1.10.8.10-ff-15593.reduced.sto                          63    203  95.88  17.70
```

Now go and [have a look at the documentation](https://cathpy.readthedocs.io/en/latest/).

## Contributing

There are many ways to contribute, all of which are most welcome.

 * If something is not clear then you have identified a gap in the documentation, please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new) 
 * If it looks like you should be able to do something that you can't then you've either identified a new feature request or a documentation gap - please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new)
 * If you have noticed some unexpected behaviour, you may have found a bug - please let us know by [raising a new issue](https://github.com/UCL/cathpy/issues/new)

When you do raise an issue, it is extremely helpful if you first check that a similar issue has not already been registered. It would also be great if you can be as clear, concise and specific as possible. If you are reporting a potential bug, please try to provide steps that will allow us to reproduce the unexpected behaviour.

If you accompany your issue with a Pull Request that actually solves the documentation / feature request / bug fix then you may well be eligible for doughnuts.

## Development

If you are developing, then this is the general recommended flow:

Get access to the latest version of the code and create a new branch (with a descriptive summary of your new feature/bugfix):

```sh
$ git clone git@github.com:UCL/cathpy.git
$ cd cathpy
$ git checkout -b my-awesome-new-feature
```

Install the code (as editable package) into virtual environment

```sh
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -e .
```

Write your tests, make your changes then make sure your tests (and all the other tests) still pass:

```sh
$ vim tests/my_new_feature_test.py
$ vim cathpy/my_new_feature.py
$ pytest
```

Then push your changes back to GitHub and raise a pull request through the web pages.

```sh
$ git push
```

## FAQ

**What is cathpy?**

`cathpy` is a python package that contains bioinformatics tools and libraries
used in [CATH](http://cathdb.info) (protein structure classification resource at UCL).

**Hmmm.. that sounds like Yet Another Python Bioinformatics Toolkit?**

Well it is... sort of.

**Should I be using it?**

If you are looking for a general Bioinformatics toolkit, you should look at [BioPython](https://biopython.org/) first.

The `cathpy` project does contain some generic functionality that may overlap with BioPython,
however we are definitely not trying to rewrite that library. It has been published mainly for 
internal use (within CATH), however it has been released as open source in case others find the tools helpful.

## External software

This code base contains external tools that are not written and maintained by the authors
of this project. If you use the results of these tools, please reference the relevant papers.

#### GroupSim

Characterization and Prediction of Residues Determining Protein Functional Specificity.
**Capra JA and Singh M (2008).**<br>
*Bioinformatics, 24(13): 1473-1480, 2008.*

#### Scorecons

Scoring residue conservation.
**Valdar WSJ (2002)**<br>
*Proteins: Structure, Function, and Genetics. 43(2): 227-241, 2002.*

## References

The most recent paper describing the CATH protein structure database:

CATH: expanding the horizons of structure-based functional annotations for genome sequences.
**Sillitoe I, et al (2018)**<br>
*Nucleic Acids Research, Volume 47, Issue D1, 08 January 2019, Pages D280–D284, https://doi.org/10.1093/nar/gky1097*





%prep
%autosetup -n cathpy-0.4.1

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

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

%changelog
* Fri Jun 09 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.1-1
- Package Spec generated