Get your package started by converting scripts you have already written. You'll create a simple package which you can use on your own computer.

Starting a package

Modules, packages and subpackages

From script to package

Putting your package to work

Documentation

Writing function documentation with pyment

Writing function documentation with pyment II

Package and module documentation

Structuring imports

Sibling imports

Importing from parents

Exposing functions to users

From Loose Code to Local Package

Make your package installable for yourself and others. In this chapter, you'll learn to deal with dependencies,  write READMEs, and include licenses. You'll also complete all the steps to publish your package on PyPI—the main home of Python packages.

Installing your own package

Adding the setup script

Installing your package locally

Utilizing editable installs

Dealing with dependencies

User dependencies

Development dependencies

Including licences and writing READMEs

Writing a README

MANIFEST - Including extra files with your package

Publishing your package

Building a distribution

Uploading distributions

Install Your Package from Anywhere

Bring your package up to a professional standard. Discover how to use pytest to guard against errors, tox to test if your package functions with multiple versions of Python, and flake8 to maintain great code style.

Testing your package

Creating the test directory

Writing some basic tests

Running your tests

Testing your package with different environments

Setting up tox

Running tox

Keeping your package stylish

Appropriate style filtering

Using flake8 to tidy up a file

Ignoring specific errors

Configuring flake8

Increasing Your Package Quality

Create your packages more quickly. In this final chapter, you’ll learn how to use cookiecutter to generate all the supporting files your package needs, Makefiles to simplify releasing new versions, and be introduced to the last few files your package needs to attract users and contributors.

Faster package development with templates

# Run this script to create package template
# After running you will still need to type in the terminal to specify the template options
cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git


Using package templates

Version numbers and history

CONTRIBUTING.md

# History

## ____
### _____
____
### ____
____

## 0.1.0
### Added
- First release on PyPI.


# History

## 0.2.0
### Fixed
- Bug fixed in `length` subpackage for inches-to-feet conversion.
### Deprecated
- Removed Python 2.7 support.

## 0.1.0
### Added
- First release on PyPI.


History file

#!/usr/bin/env python

"""The setup script."""

from setuptools import setup, find_packages

with open('README.md') as readme_file:
    readme = readme_file.read()

with open('HISTORY.md') as history_file:
	history = history_file.read()

setup(
	author="All credit to you",
    author_email='you@chapter4.com',
    description="A package for converting between imperial unit lengths and weights.",
    name='impyrial',
    packages=find_packages(include=['impyrial', 'impyrial.*']),
    version='0.1.0',
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.6.*",
    classifiers=[
        'Development Status :: 2 - Pre-Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Natural Language :: English',
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
    ],
    license="MIT license",
    long_description=readme + '\n\n' + history,
    keywords='impyrial',    
    zip_safe=False,
)


__doc__ = """
impyrial
========
A package for converting between imperial measurments of length and weight.
"""

__author__ = "All credit to you"
__version__ = '0.1.0'

from . import length  # noqa : F401
from . import weight  # noqa : F401


# Copy and run this command in the terminal to increase the minor package number
bumpversion minor


Tracking version number with bumpversion

Makefiles and classifiers

#!/usr/bin/env python

"""The setup script."""

from setuptools import setup, find_packages

with open('README.md') as readme_file:
    readme = readme_file.read()

with open('HISTORY.md') as history_file:
    history = history_file.read()

setup(
    author="All credit to you",
    author_email='you@chapter4.com',
    description="A package for converting between imperial unit lengths and weights.",
    name='impyrial',
    packages=find_packages(include=['impyrial', 'impyrial.*']),
    version='0.1.0',
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.6.*",
    classifiers=[
        'Development Status :: 2 - Pre-Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Natural Language :: English',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
    ],
    license="MIT license",
    long_description=readme + '\n\n' + history,
    long_description_content_type='text/markdown',
    keywords='impyrial',    
    zip_safe=False,
)


#!/usr/bin/env python

"""The setup script."""

from setuptools import setup, find_packages

with open('README.md') as readme_file:
    readme = readme_file.read()

with open('HISTORY.md') as history_file:
    history = history_file.read()

setup(
    author="All credit to you",
    author_email='you@chapter4.com',
    description="A package for converting between imperial unit lengths and weights.",
    name='impyrial',
    packages=find_packages(include=['impyrial', 'impyrial.*']),
    version='0.1.0',
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.6.*",
    classifiers=[
        'Development Status :: 2 - Pre-Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Natural Language :: English',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
    ],
    license="MIT license",
    long_description=readme + '\n\n' + history,
    long_description_content_type='text/markdown',
    keywords='impyrial',    
    zip_safe=False,
)


PyPI classifiers

# Run this file to complete the exercise 

# Remove old distributions
make clean

# Run tests
make test

# Make new source and wheel distributions
make dist


Using makefiles

Wrap-up

Rapid Package Development

Do you find yourself copying and pasting the same code between files, wishing it was easier to reuse and share your awesome snippets? Wrapping your code into Python packages can help! In this course, you’ll learn about package structure and the extra files needed to turn loose code into convenient packages. You'll also learn about import structure, documentation, and how to maintain code style using flake8. You’ll then speed up your package development by building templates, using cookiecutter to create package skeletons. Finally, you'll learn how to use setuptools and twine to build and publish your packages to PyPI—the world stage for Python packages.

Introduction to Shell

Writing Functions in Python

Learn about package structure, import structure, documentation, and how to maintain code style then build templates and use setup tools to publish them.

Developing Python Packages

Learn to create your own Python packages to make your code easier to use and share with others.

Using makefiles

Developing Python Packages

Exercise instructions

Hands-on interactive exercise