summaryrefslogtreecommitdiff
path: root/python-cpgclientlib.spec
blob: 1d734f3f50250cd0dc2f0fd28bdb905fd24270a2 (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
%global _empty_manifest_terminate_build 0
Name:		python-cpgclientlib
Version:	0.11.321
Release:	1
Summary:	A client library for CPG servers
License:	Apache Software License
URL:		https://github.com/ShiftLeftSecurity/codepropertygraph
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/07/5b/54cb83bf2f7349a39d52594440498538c53b75974c6ffeefb0f2f78cffa7/cpgclientlib-0.11.321.tar.gz
BuildArch:	noarch


%description
# A Python client library for Joern Server

A library to script code analyzers based on code property graphs
(e.g., Joern/Ocular) via Python.


## Requirements

* Python 3 and Pip(we do _not_ support Python 2.7)
  see (https://packaging.python.org/tutorials/installing-packages/)

## Installation

To download and install the latest version, issue the following command:

```
pip install cpgclientlib
```

## Usage

Assuming that `joernd` is running locally, the following short scripts creates a code property graph and runs a query to retrieve all methods in JSON format.

```python
#!/usr/bin/env python3

from cpgclient.CpgClient import CpgClient

server = '127.0.0.1'
port = 8080
client = CpgClient(server, port)
client.create_cpg('/path/to/cpg')
methods = client.query('cpg.method.toJson')
print(methods)
```

## References

* Code Property Graph specification and tools
  https://github.com/ShiftLeftSecurity/codepropertygraph/
* The open source code analyze joern: https://joern.io
* ShiftLeft Ocular: https://ocular.shiftleft.io

%package -n python3-cpgclientlib
Summary:	A client library for CPG servers
Provides:	python-cpgclientlib
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-cpgclientlib
# A Python client library for Joern Server

A library to script code analyzers based on code property graphs
(e.g., Joern/Ocular) via Python.


## Requirements

* Python 3 and Pip(we do _not_ support Python 2.7)
  see (https://packaging.python.org/tutorials/installing-packages/)

## Installation

To download and install the latest version, issue the following command:

```
pip install cpgclientlib
```

## Usage

Assuming that `joernd` is running locally, the following short scripts creates a code property graph and runs a query to retrieve all methods in JSON format.

```python
#!/usr/bin/env python3

from cpgclient.CpgClient import CpgClient

server = '127.0.0.1'
port = 8080
client = CpgClient(server, port)
client.create_cpg('/path/to/cpg')
methods = client.query('cpg.method.toJson')
print(methods)
```

## References

* Code Property Graph specification and tools
  https://github.com/ShiftLeftSecurity/codepropertygraph/
* The open source code analyze joern: https://joern.io
* ShiftLeft Ocular: https://ocular.shiftleft.io

%package help
Summary:	Development documents and examples for cpgclientlib
Provides:	python3-cpgclientlib-doc
%description help
# A Python client library for Joern Server

A library to script code analyzers based on code property graphs
(e.g., Joern/Ocular) via Python.


## Requirements

* Python 3 and Pip(we do _not_ support Python 2.7)
  see (https://packaging.python.org/tutorials/installing-packages/)

## Installation

To download and install the latest version, issue the following command:

```
pip install cpgclientlib
```

## Usage

Assuming that `joernd` is running locally, the following short scripts creates a code property graph and runs a query to retrieve all methods in JSON format.

```python
#!/usr/bin/env python3

from cpgclient.CpgClient import CpgClient

server = '127.0.0.1'
port = 8080
client = CpgClient(server, port)
client.create_cpg('/path/to/cpg')
methods = client.query('cpg.method.toJson')
print(methods)
```

## References

* Code Property Graph specification and tools
  https://github.com/ShiftLeftSecurity/codepropertygraph/
* The open source code analyze joern: https://joern.io
* ShiftLeft Ocular: https://ocular.shiftleft.io

%prep
%autosetup -n cpgclientlib-0.11.321

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

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

%changelog
* Tue Apr 25 2023 Python_Bot <Python_Bot@openeuler.org> - 0.11.321-1
- Package Spec generated