-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
318 lines (247 loc) · 8.18 KB
/
index.html
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
<!DOCTYPE html>
<html>
<head>
<title>Empaquetar - Com empaquetar i distribuïr els nostres paquets de Python</title>
<meta charset="utf-8">
<style>
@import url(https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz);
@import url(https://fonts.googleapis.com/css?family=Roboto);
@import url(https://fonts.googleapis.com/css?family=Roboto+Mono);
body { font-family: 'Roboto'; }
h1, h2, h3 {
font-family: 'Yanone Kaffeesatz';
font-weight: normal;
margin-bottom: 0px;
}
.remark-code, .remark-inline-code { font-family: 'Roboto Mono'; font-size: 0.6em }
.small {
font-size: 0.8em;
}
a:link, a:visited {
color: #E40066;
text-decoration: underline;
}
</style>
</head>
<body>
<textarea id="source">
class: center, middle
count: false
# Com empaquetar
## Empaquetar i distribuïr els nostres paquets de Python
[Eduard Carreras i Nadal](mailto:[email protected])
31/03/2022 - PyGRN #22
[](http://creativecommons.org/licenses/by-sa/4.0/)
---
# Qui sóc jo?
- Sóc un infiltrat en el món del software (sóc teleco)
- Apassionat del software i del proćes **art**esanal.
- Co-Fundador de [GISCE-TI, S.L](http://gisce.net)
- Desenvolupant en Python des del 2007 (Python ❤️)
- Amant del programari lliure
- [LinkedIn](https://www.linkedin.com/in/ecarreras/), [Twitter](https://twitter.com/ecarreras)
i [GitHub](https://github.com/ecarreras)
---
# Agenda
1. Què és un paquet de Python
2. Estructura d'un paquet
3. Integrar amb scripts (CLI)
4. Què són els `entry_points`?
5. Alternatives a setuptools
6. Referències
7. Preguntes?
---
# Què és un paquet de Python
- Una col·lecció de mòduls agrupats per un objectiu/funcionalitat (llibreria).
- Ex. [Requests](https://docs.python-requests.org/en/latest/): comunicació HTTP
- Ex. [SQLAlchemy](https://www.sqlalchemy.org/): ORM per diferents bases de dades
- La manera més comuna d'instal·lar un paquet és a través de `pip` i el repositori [Pypi](https://pypi.org/)
- Ex. `python3 -m pip install requests`
## Però avui no apendrem a instal·lar i gestionar entorns!
- Això ho deixem per alguna altre sessió 😉
## Avui farem i publicarem els nostres paquets! 🔝
???
- https://stackoverflow.com/questions/62983756/what-is-pyproject-toml-file-for
---
# Estructura d'un paquet
### Tenim el següent projecte
```
sampleproject/
└── src/
└── sample/
├── __init__.py
└── simple.py
```
- On el contingut de `simple.py` és:
```python
def add_one(number):
return number + 1
```
---
# Estructura d'un paquet
```
sampleproject/
├── LICENSE
├── pyproject.toml(*)
├── README.md
├── setup.py ⬅️
├── MANIFEST.in
├── requirements.txt
├── src/
│ └── sample/
│ ├── __init__.py
│ └── simple.py
└── tests/
```
- Hi ha el fitxer `setup.py` que s'utilitza per definir el paquet
- Es pot fer servir `setup.cfg` que és el mateix, però no és dinàmic.
- 💡 El `.py` s'executa en el moment d'instal·lació.
- ⚠️ Si hi ha algun error en el `setup.py` no instal·larà.
---
## Fitxer setup.py
- Llistat complet de les [keywords](https://setuptools.pypa.io/en/latest/references/keywords.html)
```python
import setuptools
with open("README.md", "r", encoding="utf-8") as fh:
long_description = fh.read()
with open("requirements.txt") as r:
install_requires = [x.strip() for x in r.readlines()]
setuptools.setup(
name="sample-ecarreras",
version="0.0.1",
author="Example Author",
author_email="[email protected]",
description="A small example package",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/pypa/sampleproject",
project_urls={
"Bug Tracker": "https://github.com/pypa/sampleproject/issues",
},
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
package_dir={"": "src"},
install_requires=install_requires,
packages=setuptools.find_packages(where="src"),
python_requires=">=3.6",
)
```
---
# Pujar el nostre paquet
- Farem servir una utilitat que es diu [twine](https://twine.readthedocs.io/en/stable/)
- Necessitem un [compte a Pypi](https://pypi.org/account/register/)
```
python3 -m pip install twine
python3 setup.py sdist # Creem el paquet a la carpeta /dist
twine upload dist/sample-ecarreras-0.0.1.tar.gz
```
- Ara ja el podem instal·lar! 👏
```
python3 -m pip install sample-ecarreras
```
- Podem automatitzar-ho amb [Github Actions](https://github.com/pypa/sampleproject/blob/main/.github/workflows/release.yml), de forma
que quan fem un tag al repositori ens pugi el paquet
---
# Integrar amb scripts (CLI)
- Moltes vegades volem crear utilitzats a través de comandes
- Farem servir [Click](https://click.palletsprojects.com/) però podem fer servir només stdlib
```
├── src/
│ └── sample/
│ ├── __init__.py
│ └── simple.py
│ └── cli.py
```
```python
import click
from sample.simple import add_one
@click.command()
@click.argument('number', nargs=1, type=click.INT)
def main(number):
print(add_one(number))
if __name__ == '__main__':
main()
```
- Això ja es pot executar amb l'intèrpret de python, però volem que ens creï un executable
del tipus:
```
$ add_one 6
7
```
---
# Integrar amb scripts (CLI)
- Utilitzarem un paràmetre anomenat [`console_scripts`](https://setuptools.pypa.io/en/latest/userguide/entry_point.html) del `setup.py`
```python
setup(
entry_points={
'console_scripts': [
'add_one = sample.cli:main'
]
}
)
```
- Es pot indicar quin nom tindrà l'script (add_one en aquest cas)
- On es troba la funció que ha d'executar (la funció `main` que es troba a `sample.cli` )
---
# Què són els `entry_points`?
- Ho hem fet servir abans per crear scripts executables, però serveix per molt més
- És una forma que ens permet que altres paquets interaccionin amb el nostre, com
un sistema de *plug-ins*.
- Funciona amb una clau que té diferents valors
## Com els podem descobrir?
```python
from importlib import metadata
eps = metadata.entry_points()['my_entry_point_name']
for ep in eps:
plugin = ep.load()
plugin()
```
- Exemple de [plugins amb PyTest](https://docs.pytest.org/en/latest/how-to/writing_plugins.html#setuptools-entry-points)
---
# Alternatives a setuptools
- Fins fa un temps l'única manera de crear i distribuir paquets era amb `setuptools`
- `setuptools` no forma part de l'stdlib, què passa si no el tenim?
## pyproject.toml
- Entra en joc el `pyproject.toml`, aquest fitxer ens defineix com construir el paquet
```toml
[build-system]
requires = ["setuptools>=42"]
build-backend = "setuptools.build_meta"
```
- Aquest moviment, ha obert la manera de gestionar paquets i ens permet fer servir altres eines
com [Poetry](https://python-poetry.org/), [Flit](https://flit.pypa.io/en/latest/) o [PDM](https://pdm.fming.dev/)
### PEPs
- [PEP-518](https://peps.python.org/pep-0518/), [PEP-517](https://peps.python.org/pep-0517/), [PEP-621](https://peps.python.org/pep-0621/),
[PEP-660](https://peps.python.org/pep-0660/)
---
# Referències
- [Python Packaging User Guide](https://packaging.python.org/en/latest/)
- [Python Packaging Authority](https://www.pypa.io/en/latest/)
- [Llista de classificats pels paquests](https://pypi.org/classifiers/)
- [GitHub PyPA](https://github.com/pypa)
- [Documentació Setuptools](https://setuptools.pypa.io/)
---
class: center, middle
# Preguntes?
# 🙈 🙉 🙊
---
class: center, middle
# Moltes gràcies!
</textarea>
<script src="https://remarkjs.com/downloads/remark-latest.min.js">
</script>
<script>
var slideshow = remark.create({
highlightStyle: 'darcula',
highlightLanguage: 'remark',
highlightLines: true,
slideNumberFormat: '%current%/%total%',
ratio: '4:3'
});
</script>
</body>
</html>