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

# Import required functions
____

# Call setup function
____(
    author="<your-name>",
    description="____",
    name="____",
    packages=____(____=____),
    version="____",
)


# Import required functions
from setuptools import setup, find_packages

# Call setup function
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",
)


Lägga till installationsskriptet

import impyrial

result = impyrial.length.convert_unit(10, 'in', 'yd')
print(result)


# Run this to install the package locally
pip install -e .


Installera ditt paket lokalt

"""Conversions between ounces and larger imperial weight units"""
OUNCES_PER_POUND = 160  # 16 ounces in a pound
OUNCES_PER_STONE = OUNCES_PER_POUND * 14.0  # 14 pounds in a stone

UNITS = ("oz", "lb", "st")


def ounces_to_pounds(x, reverse=False):
    """Convert weights between ounces and pounds.

    Parameters
    ----------
    x : array_like
        Weights in pounds.
    reverse : bool, optional
        If this is set to true this function converts from pounds to ounces
        instead of the default behaviour of ounces to pounds.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_POUND
    else:
        return x / OUNCES_PER_POUND


def ounces_to_stone(x, reverse=False):
    """Convert weights between ounces and stone.

    Parameters
    ----------
    x : array_like
        Weights in stone.
    reverse : bool, optional
        If this is set to true this function converts from stone to ounces
        instead of the default behaviour of ounces to stone.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_STONE
    else:
        return x / OUNCES_PER_STONE


import impyrial

result = impyrial.weight.convert_unit(2, 'lb', 'oz')
print(result)


"""Conversions between ounces and larger imperial weight units"""
OUNCES_PER_POUND = 16.0  # 16 ounces in a pound
OUNCES_PER_STONE = OUNCES_PER_POUND * 14.0  # 14 pounds in a stone

UNITS = ("oz", "lb", "st")


def ounces_to_pounds(x, reverse=False):
    """Convert weights between ounces and pounds.

    Parameters
    ----------
    x : array_like
        Weights in pounds.
    reverse : bool, optional
        If this is set to true this function converts from pounds to ounces
        instead of the default behaviour of ounces to pounds.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_POUND
    else:
        return x / OUNCES_PER_POUND


def ounces_to_stone(x, reverse=False):
    """Convert weights between ounces and stone.

    Parameters
    ----------
    x : array_like
        Weights in stone.
    reverse : bool, optional
        If this is set to true this function converts from stone to ounces
        instead of the default behaviour of ounces to stone.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_STONE
    else:
        return x / OUNCES_PER_STONE


Använda redigerbara installationer

Hantera beroenden

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",
    ____=____,
)


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'],
)


Användarberoenden

# Run this script to install the package locally
pip freeze > requirements.txt


Utvecklingsberoenden

Licenser och README-filer

____

A package for converting between imperial unit lengths and weights.

This package was created for the ____DataCamp____ course "Developing Python Packages".

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

____
import impyrial

# Convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# Convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
____


# impyrial

A package for converting between imperial unit lengths and weights.

This package was created for the [DataCamp](https://www.datacamp.com) course "Developing Python Packages".

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

```
import impyrial

# Convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# Convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
```


Skriva en README

# impyrial

A package for converting between imperial unit lengths and weights.

This package was created for the [DataCamp](https://www.datacamp.com) course Developing Python Packages.

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

```
import impyrial

# convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
```


MANIFEST – inkludera extrafiler i ditt paket

Publicera ditt paket

# Run this code to complete the exercise
python3 setup.py sdist bdist_wheel


Bygga en distribution

# Run the following in the terminal:
# twine upload dist/*


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

Skapa testkatalogen

Skriva grundläggande tester

Kör dina tester

Testa ditt paket i olika miljöer

Konfigurera tox

Köra tox

Håll paketet stilrent

Lämplig stilfiltrering

Städa upp en fil med flake8

Ignorera specifika fel

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.

MANIFEST – inkludera extrafiler i ditt paket

Att utveckla Python-paket

Interaktiv övning med praktiskt arbete