Kom igång med ditt paket genom att omvandla skript du redan har skrivit. Du skapar ett enkelt paket som du kan använda på din egen dator.

Starta ett paket

Moduler, paket och underpaket

Från skript till paket

Sätt ditt paket i arbete

Dokumentation

Skriv funktionsdokumentation med pyment

Skriva funktionsdokumentation med pyment II

Dokumentation för paket och moduler

Strukturera importer

Syskonimporter

Importera från överordnade moduler

Exponera funktioner för användare

Från lös kod till lokalt paket

Gör ditt paket installerbart för dig själv och andra. I det här kapitlet lär du dig hantera beroenden, skriva README-filer och inkludera licenser. Du går också igenom alla steg för att publicera ditt paket på PyPI – den huvudsakliga platsen för Python-paket.

Installera ditt eget paket

Lägga till installationsskriptet

Installera ditt paket lokalt

Använda redigerbara installationer

Hantera beroenden

Användarberoenden

Utvecklingsberoenden

Licenser och README-filer

Skriva en README

MANIFEST – inkludera extrafiler i ditt paket

Publicera ditt paket

Bygga en distribution

Ladda upp distributioner

Installera ditt paket var som helst

Lyft ditt paket till professionell nivå. Lär dig använda pytest för att skydda mot fel, tox för att testa om ditt paket fungerar med flera Python-versioner och flake8 för att upprätthålla god kodstil.

Testa ditt paket

from impyrial.length.core import inches_to_feet, inches_to_yards


Skapa testkatalogen

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def ____():
	# Check that 12 inches is converted to 1.0 foot
    ____ ____(____) == 1.0 
    # Check that 2.5 feet is converted to 30.0 inches
    ____ ____(____, reverse=True) == ____


from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1.0 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30.0 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0


Skriva grundläggande tester

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0
    


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 120  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 12.0  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


Kör dina tester

Testa ditt paket i olika miljöer

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


Konfigurera tox

[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest
    


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
    #python_requires="==____.*",
)


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.9.*",
)


Köra tox

Håll paketet stilrent

Lämplig stilfiltrering

"""Main module."""

def absolute_value(num):
    """Return the absolute value of the number"""
    if num>=0: return num
    else:
    	return -num


"""Main module."""


def absolute_value(num):
    """Return the absolute value of the number"""
    if num >= 0:
        return num
    else:
        return -num


Städa upp en fil med flake8

import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # ____: ____
    return l


import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # noqa: E741
    return l


Ignorera specifika fel

[flake8]

# Ignore F401 violations in the main __init__.py file
# per-file-ignores =
#     ____ : ____
        
# Ignore all violations in the tests directoory
# exclude = ____


from impyrial.length.api import (
    convert_unit,
    unit_to_mixed,
    mixed_to_unit,
)

def test_convert_unit():
    assert convert_unit(30, "ft", "in")==360.0
    assert convert_unit(30, "yd", "ft")==90.0
    assert convert_unit(10, "mi", "yd")==17600.0


[flake8]

# Ignore F401 violations in the main __init__.py file
per-file-ignores =
    impyrial/__init__.py: F401
        
# Ignore all violations in the tests directoory
exclude = tests/*


Konfigurera flake8

Förbättra paketets kvalitet

Skapa dina paket snabbare. I det här sista kapitlet lär du dig använda cookiecutter för att generera alla stödfiler ditt paket behöver, Makefiles för att förenkla lansering av nya versioner, och du introduceras till de sista filerna ditt paket behöver för att locka användare och bidragsgivare.

Snabbare paketutveckling med mallar

Använda paketmallar

Versionsnummer och historik

CONTRIBUTING.md

Historikfil

Spåra versionsnummer med bumpversion

Makefiles och klassificerare

PyPI-klassificerare

Använda makefiles

Avslutning

Snabb paketutveckling

Kopierar du samma kod mellan filer och önskar att det vore enklare att återanvända och dela dina kodsnuttar? Lösningen är att paketera koden som Python-paket! I den här kursen lär du dig om paketstruktur och de extrafiler som behövs för att omvandla lös kod till praktiska paket. Du lär dig också om importstruktur, dokumentation och hur du upprätthåller kodstil med flake8. Sedan effektiviserar du paketutvecklingen genom att bygga mallar och använda cookiecutter för att skapa paketskelett. Slutligen lär du dig hur du använder setuptools och twine för att bygga och publicera dina paket på PyPI – den viktigaste plattformen för Python-paket.

Introduction to Shell

Writing Functions in Python

Lär dig om paketstruktur, importstruktur, dokumentation och kodstil. Bygg mallar och publicera dem.

Att utveckla Python-paket

Lär dig skapa egna Python-paket för att göra din kod enklare att använda och dela med andra.

Skriva grundläggande tester

Att utveckla Python-paket

Interaktiv övning med praktiskt arbete