summaryrefslogtreecommitdiff
path: root/python-botostubs.spec
blob: 2a089e6d9b878d47f2eb7d83aa6172712a64f947 (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
%global _empty_manifest_terminate_build 0
Name:		python-botostubs
Version:	0.15.1.23.10
Release:	1
Summary:	boto3 code assistance for any API in any IDE, always up to date
License:	BSD-2-Clause
URL:		https://github.com/jeshan/botostubs
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/05/db/ac8d384f11075c97b52d0150e9c00efd7f551d9163ed66cf1ca0938ff619/botostubs-0.15.1.23.10.tar.gz
BuildArch:	noarch


%description
![](https://img.shields.io/badge/programmer-laziness-green.svg)
[![PyPI version](https://badge.fury.io/py/botostubs.svg)](https://badge.fury.io/py/botostubs)

[![Downloads](https://pepy.tech/badge/botostubs)](https://pepy.tech/project/botostubs)
[![Downloads](https://pepy.tech/badge/botostubs/month)](https://pepy.tech/project/botostubs)
[![Downloads](https://pepy.tech/badge/botostubs/week)](https://pepy.tech/project/botostubs)

![Build badge](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiUkF6bllTcVBkQmI2Y0FWZlpDUTRHc3pyVm5EUk11ZWdDV1BtcVAyZG80TCtJZFZUdnB1ZmFwRVN3UWxudUJxMTRTTW15R1dnUy9KZFZuZE1Fd3c1b1RjPSIsIml2UGFyYW1ldGVyU3BlYyI6IlNZa3Q2aHRjWjVYVzQ0clkiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)


# botostubs
Gives you code assistance for **any boto3 API** in any IDE. Get started by running `pip install botostubs`


# Demo
![See demo gif on github](https://raw.githubusercontent.com/jeshan/botostubs/master/intro-demo.gif)


# Features
- PyPI package automatically aligned with boto3 (yay!)
- show required / optional fields
- show API docs as Python docstrings
- full api coverage
- support for boto3 clients, e.g `type: botostubs.ACM`
- support for service-level resources, e.g `type: botostubs.S3.S3Resource`
- support for paginators, e.g `type: botostubs.EC2.DescribeInstancesPaginator`
- support for waiters, e.g `type: botostubs.EC2.InstanceRunningWaiter`

# How it works
We look for all boto3 clients by running boto itself. Then loop over each of them to find what operations and classes are used. These are all dumped in a new python script, packaged in this project. This way, `botostubs` can offer comprehensive API coverage.

The deployment pipeline on AWS checks for boto3 releases every 3 days, installs it, generate new stubs and pushes them to PyPI. Looking for a new API released a few days ago? Just upgrade the package with `pip install --upgrade botostubs` and you're good to go.

For an in-depth account, see the blog post [Code assistance for boto3, always up to date and in any IDE](https://www.awsadvent.com/2018/12/21/code-assistance-for-boto3-always-up-to-date-and-in-any-ide/)

# Notes
- This package requires that your IDE already supports getting type hints from PyPI packages. It has been tested with Intellij and Visual Studio Code.
- If you are not seeing code completion in Intellij-based ones, please increase the intellisense filesize limit e.g `idea.max.intellisense.filesize=30000` in IDE custom properties (Help > Edit Custom Properties), then restart
- For other IDEs, you may have some luck by installing [jedi](https://github.com/davidhalter/jedi), which provides code completion for Vim, Emacs, Sublime, Atom, etc.

# TODO
Support python versions before 3.6. Currently requires at least 3.6 due to use of type hints.

# Credits
`pyboto3` for inspiration behind this. It supported only legacy Python and not Python 3. Besides, it is no longer being maintained.

# For forkers
## Automated releasing on pypi
Deploy the pipeline in your AWS account by clicking this button:
<a href="https://console.aws.amazon.com/cloudformation/home?#/stacks/new?&templateURL=https://s3.amazonaws.com/jeshan-oss-public-files/deployment-pipeline.yaml" target="_blank"><img src="https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png"></a>

This is how it looks like:

![stack](/stack.png)

*Image automatically generated with [cfnbuddy](https://www.cfnbuddy.com)*

## Manual Releasing on pypi
- `docker-compose build`
- `docker-compose run python`. Enter credentials when prompted




%package -n python3-botostubs
Summary:	boto3 code assistance for any API in any IDE, always up to date
Provides:	python-botostubs
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-botostubs
![](https://img.shields.io/badge/programmer-laziness-green.svg)
[![PyPI version](https://badge.fury.io/py/botostubs.svg)](https://badge.fury.io/py/botostubs)

[![Downloads](https://pepy.tech/badge/botostubs)](https://pepy.tech/project/botostubs)
[![Downloads](https://pepy.tech/badge/botostubs/month)](https://pepy.tech/project/botostubs)
[![Downloads](https://pepy.tech/badge/botostubs/week)](https://pepy.tech/project/botostubs)

![Build badge](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiUkF6bllTcVBkQmI2Y0FWZlpDUTRHc3pyVm5EUk11ZWdDV1BtcVAyZG80TCtJZFZUdnB1ZmFwRVN3UWxudUJxMTRTTW15R1dnUy9KZFZuZE1Fd3c1b1RjPSIsIml2UGFyYW1ldGVyU3BlYyI6IlNZa3Q2aHRjWjVYVzQ0clkiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)


# botostubs
Gives you code assistance for **any boto3 API** in any IDE. Get started by running `pip install botostubs`


# Demo
![See demo gif on github](https://raw.githubusercontent.com/jeshan/botostubs/master/intro-demo.gif)


# Features
- PyPI package automatically aligned with boto3 (yay!)
- show required / optional fields
- show API docs as Python docstrings
- full api coverage
- support for boto3 clients, e.g `type: botostubs.ACM`
- support for service-level resources, e.g `type: botostubs.S3.S3Resource`
- support for paginators, e.g `type: botostubs.EC2.DescribeInstancesPaginator`
- support for waiters, e.g `type: botostubs.EC2.InstanceRunningWaiter`

# How it works
We look for all boto3 clients by running boto itself. Then loop over each of them to find what operations and classes are used. These are all dumped in a new python script, packaged in this project. This way, `botostubs` can offer comprehensive API coverage.

The deployment pipeline on AWS checks for boto3 releases every 3 days, installs it, generate new stubs and pushes them to PyPI. Looking for a new API released a few days ago? Just upgrade the package with `pip install --upgrade botostubs` and you're good to go.

For an in-depth account, see the blog post [Code assistance for boto3, always up to date and in any IDE](https://www.awsadvent.com/2018/12/21/code-assistance-for-boto3-always-up-to-date-and-in-any-ide/)

# Notes
- This package requires that your IDE already supports getting type hints from PyPI packages. It has been tested with Intellij and Visual Studio Code.
- If you are not seeing code completion in Intellij-based ones, please increase the intellisense filesize limit e.g `idea.max.intellisense.filesize=30000` in IDE custom properties (Help > Edit Custom Properties), then restart
- For other IDEs, you may have some luck by installing [jedi](https://github.com/davidhalter/jedi), which provides code completion for Vim, Emacs, Sublime, Atom, etc.

# TODO
Support python versions before 3.6. Currently requires at least 3.6 due to use of type hints.

# Credits
`pyboto3` for inspiration behind this. It supported only legacy Python and not Python 3. Besides, it is no longer being maintained.

# For forkers
## Automated releasing on pypi
Deploy the pipeline in your AWS account by clicking this button:
<a href="https://console.aws.amazon.com/cloudformation/home?#/stacks/new?&templateURL=https://s3.amazonaws.com/jeshan-oss-public-files/deployment-pipeline.yaml" target="_blank"><img src="https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png"></a>

This is how it looks like:

![stack](/stack.png)

*Image automatically generated with [cfnbuddy](https://www.cfnbuddy.com)*

## Manual Releasing on pypi
- `docker-compose build`
- `docker-compose run python`. Enter credentials when prompted




%package help
Summary:	Development documents and examples for botostubs
Provides:	python3-botostubs-doc
%description help
![](https://img.shields.io/badge/programmer-laziness-green.svg)
[![PyPI version](https://badge.fury.io/py/botostubs.svg)](https://badge.fury.io/py/botostubs)

[![Downloads](https://pepy.tech/badge/botostubs)](https://pepy.tech/project/botostubs)
[![Downloads](https://pepy.tech/badge/botostubs/month)](https://pepy.tech/project/botostubs)
[![Downloads](https://pepy.tech/badge/botostubs/week)](https://pepy.tech/project/botostubs)

![Build badge](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiUkF6bllTcVBkQmI2Y0FWZlpDUTRHc3pyVm5EUk11ZWdDV1BtcVAyZG80TCtJZFZUdnB1ZmFwRVN3UWxudUJxMTRTTW15R1dnUy9KZFZuZE1Fd3c1b1RjPSIsIml2UGFyYW1ldGVyU3BlYyI6IlNZa3Q2aHRjWjVYVzQ0clkiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)


# botostubs
Gives you code assistance for **any boto3 API** in any IDE. Get started by running `pip install botostubs`


# Demo
![See demo gif on github](https://raw.githubusercontent.com/jeshan/botostubs/master/intro-demo.gif)


# Features
- PyPI package automatically aligned with boto3 (yay!)
- show required / optional fields
- show API docs as Python docstrings
- full api coverage
- support for boto3 clients, e.g `type: botostubs.ACM`
- support for service-level resources, e.g `type: botostubs.S3.S3Resource`
- support for paginators, e.g `type: botostubs.EC2.DescribeInstancesPaginator`
- support for waiters, e.g `type: botostubs.EC2.InstanceRunningWaiter`

# How it works
We look for all boto3 clients by running boto itself. Then loop over each of them to find what operations and classes are used. These are all dumped in a new python script, packaged in this project. This way, `botostubs` can offer comprehensive API coverage.

The deployment pipeline on AWS checks for boto3 releases every 3 days, installs it, generate new stubs and pushes them to PyPI. Looking for a new API released a few days ago? Just upgrade the package with `pip install --upgrade botostubs` and you're good to go.

For an in-depth account, see the blog post [Code assistance for boto3, always up to date and in any IDE](https://www.awsadvent.com/2018/12/21/code-assistance-for-boto3-always-up-to-date-and-in-any-ide/)

# Notes
- This package requires that your IDE already supports getting type hints from PyPI packages. It has been tested with Intellij and Visual Studio Code.
- If you are not seeing code completion in Intellij-based ones, please increase the intellisense filesize limit e.g `idea.max.intellisense.filesize=30000` in IDE custom properties (Help > Edit Custom Properties), then restart
- For other IDEs, you may have some luck by installing [jedi](https://github.com/davidhalter/jedi), which provides code completion for Vim, Emacs, Sublime, Atom, etc.

# TODO
Support python versions before 3.6. Currently requires at least 3.6 due to use of type hints.

# Credits
`pyboto3` for inspiration behind this. It supported only legacy Python and not Python 3. Besides, it is no longer being maintained.

# For forkers
## Automated releasing on pypi
Deploy the pipeline in your AWS account by clicking this button:
<a href="https://console.aws.amazon.com/cloudformation/home?#/stacks/new?&templateURL=https://s3.amazonaws.com/jeshan-oss-public-files/deployment-pipeline.yaml" target="_blank"><img src="https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png"></a>

This is how it looks like:

![stack](/stack.png)

*Image automatically generated with [cfnbuddy](https://www.cfnbuddy.com)*

## Manual Releasing on pypi
- `docker-compose build`
- `docker-compose run python`. Enter credentials when prompted




%prep
%autosetup -n botostubs-0.15.1.23.10

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

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

%changelog
* Fri Apr 21 2023 Python_Bot <Python_Bot@openeuler.org> - 0.15.1.23.10-1
- Package Spec generated