Dezvoltare rapidă de pachete cu șabloane

Dezvoltarea pachetelor Python

James Fulton

Climate informatics researcher

Șabloane

Pachetele Python conțin multe fișiere suplimentare
Există multe aspecte de reținut
Șabloanele simplifică acest proces

Structura fișierelor pachetului

.
|-- example_package
|   |-- __init__.py
|   `-- example_package.py
|-- tests
|   |-- __init__.py
|   `-- test_example_package.py
|-- README.rst     <-
|-- LICENSE        <-- multe
|-- MANIFEST.in    <-- fișiere
|-- tox.ini        <-- suplimentare
|-- setup.py       <--
`-- setup.cfg      <--

cookiecutter

Poate fi utilizat pentru a crea pachete Python goale
Creează toate fișierele suplimentare necesare pachetului

Structura fișierelor pachetului

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

Utilizarea cookiecutter

cookiecutter <template-url>

Utilizarea cookiecutter

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

Mai multe șabloane aici

Utilizarea cookiecutter

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

full_name [Audrey Roy Greenfeld]:

Utilizarea cookiecutter

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

full_name [Audrey Roy Greenfeld]: James Fulton

Introduceți numele și apăsați Enter pentru a continua

Utilizarea 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 utilizat în pip install name

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

Utilizarea cookiecutter

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

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

Utilizarea 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

Utilizarea 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

Rezultatul șablonului

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

Conținutul fișierului AUTHORS.rst

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

Development Lead
________________

* James Fulton <[email protected]>

Contributors
____________

None yet. Why not be the first?

Rezultatul șablonului

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

Lass uns üben!

Dezvoltarea pachetelor Python