Desarrollo de paquetes más rápido con plantillas

Desarrollo de paquetes en Python

James Fulton

Climate informatics researcher

Plantillas

Los paquetes de Python traen muchos archivos extra
Hay mucho que recordar
Usar plantillas se encarga de gran parte de esto

Árbol de archivos del paquete

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst     <-
|-- LICENSE        <-- muchos
|-- MANIFEST.in    <-- archivos
|-- tox.ini        <-- adicionales
|-- setup.py       <-- 
`-- setup.cfg      <--

cookiecutter

Sirven para crear paquetes de Python vacíos
Generan todos los archivos adicionales que tu paquete necesita

Árbol de archivos del paquete

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst
|-- LICENSE
|-- MANIFEST.in
|-- tox.ini
|-- setup.py
`-- setup.cfg

Usar cookiecutter

cookiecutter <template-url>

Usar cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

Más plantillas aquí

Usar cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

full_name [Audrey Roy Greenfeld]:

Usar cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

full_name [Audrey Roy Greenfeld]: James Fulton

Escribe tu nombre y pulsa Intro/Return para continuar

Usar cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

full_name [Audrey Roy Greenfeld]: James Fulton

email [[email protected]]: [email protected]                  
github_username [audreyr]:  MyUsername

project_name [Python Boilerplate]: mysklearn
project_slug [mysklearn]: mysklearn

Project slug: el name usado en pip install name

Usar cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

...
project_short_description [Python Boilerplate ...]: A Python package for linear 
    regression.

pypi_username [MyUsername]: 
version [0.1.0]:

Usar cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

...
use_pytest [n]: y
use_pypi_deployment_with_travis [y]: n
add_pyup_badge [n]: n

Usar cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

...
Select command_line_interface:
1 - Click
2 - Argparse
3 - No command-line interface
Choose from 1, 2, 3 [1]: 3

create_author_file [y]: y

Usar cookiecutter

cookiecutter https://github.com/audreyr/cookiecutter-pypackage

...
Select open_source_license:
1 - MIT license
2 - BSD license
3 - ISC license
4 - Apache Software License 2.0
5 - GNU General Public License v3
6 - Not open source
Choose from 1, 2, 3, 4, 5, 6 [1]: 6

Salida de la plantilla

mysklearn/
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- tests/
|   |-- __init__.py
|   `-- test_mysklearn.py
|-- MANIFEST.in
|-- README.rst
|-- requirements_dev.txt
|-- setup.cfg
|-- setup.py
|-- tox.ini

|-- AUTHORS.rst
|-- CONTRIBUTING.rst
|-- HISTORY.rst
`-- Makefile

Dentro del archivo AUTHORS.rst

=======
Créditos
=======

Responsable de desarrollo
_________________________

* James Fulton <[email protected]>

Personas colaboradoras
______________________

Aún no hay. ¿Por qué no ser la primera?

Salida de la plantilla

mysklearn/
|-- mysklearn/
|-- tests/
|-- MANIFEST.in
|-- README.rst
|-- requirements_dev.txt
|-- setup.cfg
|-- setup.py
|-- tox.ini
...
...
|-- docs/
|-- .github/
|-- .editorconfig
|-- .gitignore
`-- .travis.yml

¡Vamos a practicar!

Desarrollo de paquetes en Python