Pengembangan paket lebih cepat dengan template

Mengembangkan Paket Python

James Fulton

Climate informatics researcher

Template

Paket Python memiliki banyak file ekstra
Ada banyak hal yang harus diingat
Template membantu menangani banyak hal ini

Pohon file paket

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

cookiecutter

Dapat membuat paket Python kosong
Membuat semua file tambahan yang diperlukan paket

Pohon file paket

.
|-- 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

Menggunakan cookiecutter

cookiecutter <template-url>

Menggunakan cookiecutter

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

Template lain di sini

Menggunakan cookiecutter

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

full_name [Audrey Roy Greenfeld]:

Menggunakan cookiecutter

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

full_name [Audrey Roy Greenfeld]: James Fulton

Isi nama Anda lalu tekan Enter/Return untuk lanjut

Menggunakan 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 - name yang dipakai di pip install name

Menggunakan 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]:

Menggunakan cookiecutter

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

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

Menggunakan 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

Menggunakan 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

Hasil template

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

Di dalam file AUTHORS.rst

=======
Credits
=======

Development Lead
________________

* James Fulton <[email protected]>

Contributors
____________

Belum ada. Mengapa tidak jadi yang pertama?

Hasil template

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

Ayo berlatih!

Mengembangkan Paket Python