Skip to main content

No project description provided

Project description

pipeline status coverage report

Python best practice


Import this

!python
>>> import this
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!

setup.py

Why should you use a setup.py?

!python
from setuptools import find_packages, setup

version = "0.0.1"

setup(
    name="py_presi",
    version=version,
    packages=find_packages(),
    include_package_data=True,
    zip_safe=True,
    install_requires=["pytest", "click", "darkslide"],
    entry_points={"console_scripts": [
        "pp-build = py_presi.__main__:build"
    ]},
)

Usage:

!python
import py_presi.build
py_presi.build.build()

Structure

How is a package structured?

!bash
% tree
.
├── CHANGES.md
├── Dockerfile
├── LICENSE
├── py_presi
│   ├── build.py
│   ├── __init__.py
│   └── __main__.py
├── README.md
├── requirements.in
├── requirements.txt
├── setup.py
└── test
    └── test_me.py

Building && uploading

What is virtualenv, pip, pipenv, setuptools, pypi?

!bash
$ virtualenv env
$ source env/bin/activate

$ python setup.py install
$ python setup.py develop
$ pip install .
$ pip install -e .

# console_script
$ pp-build

# create egg sdist wheel and upload
$ python setup.py sdist bdist_wheel bdist_egg
$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Versioning

How should package be versioned?

Semantic Versioning

!bash
$ bumpversion [major|minor|patch]
$ cat .bumpversion.cfg 
[bumpversion]
current_version = 0.0.1
commit = True
tag = True

[bumpversion:file:setup.py]

Example:

!bash
# add --dry-run to test
$ bump2version --verbose patch --tag-name "{new_version}"
$ git push && git push --tags

CHANGES

How to track changes?

!bash
% cat CHANGES.md 
**unreleased**

- Update docs reflect new structure
- Add a CHANGES.md

**0.0.2**

- Added Dockerfile [jod]
- Added pip-tools
- Added gitlab registry

Libraries

Why use libraries and not put all code into the repo?

e.g. marshmallow


PEP8

Why should all code look the same?

One of Guido's key insights is that code is read much more often than it is written. The guidelines provided here are intended to improve the readability of code and make it consistent across the wide spectrum of Python code. As PEP 20 says, "Readability counts".

PEP8


Autoformatter

  • Autopep8
  • Black (we decided to use that one)
  • Yapf

Example:

!bash
% black py-presi 
reformatted /py-presi/py-presi/test/test_me.py
reformatted /py-presi/py-presi/setup.py
reformatted /py-presi/py-presi/py_presi/__main__.py
All done! ✨ 🍰 ✨
3 files reformatted, 1 file left unchanged.

Flake8

Tool For Style Guide Enforcement

!bash
$ pip install flake8
$ flake8 check.py
$ cat .flake8
[flake8]
ignore = E501 W503 W504
max-line-length = 88

Add ignore to code

!python
import superlonguglything # noqa

Add add git pre-commit-hook

!bash
$ flake8 --install-hook git
$ git config --bool flake8.strict true

Test && Coverage

Run test and create coverage report as html

!bash
$ pip install pytest pytest-cov
$ pytest test --cov py_presi --cov-report html --cov-report term
$ firefox htmlcov/index.html

Coverage


GitlabCI/CD

Gitlab hooks .gitlab-ci.yml to test and deploy code

!yaml
test:
  script:
    - pytest test --cov py_presi --cov-report term --cov-report html
    - flake8 test py_presi
  coverage: '/^TOTAL\s+\d+\s+\d+\s+(\d+\%)$/'

deploy-pypi:
  script:
    - pip install twine
    - twine upload --repository-url https://NOT_EXISTING_YET dist/*
  when: manual

deploy-docker:
  only:
    - tags

README

  • Add real description of the service
  • Add gitlab badges
  • Add install, deployment instruction
  • If a library add sphinx documentation

Sphinx e.g.


Dependencies

Pin all dependencies also inherited one

!bash
$ pip install pip-tools
$ # manage here your direct dependencies
$ vim requirements.in
$ # run pip-compile to generate requirements.txt or add remove dependencies
$ pip-compile
$ # upgrade all dependencies
$ pip-compile --upgrade

Excerpt from requirements.txt

# This file is autogenerated by pip-compile
attrs==19.3.0             # via pytest
click==7.1.1              # via -r requirements.in
coverage==5.0.3           # via pytest-cov
darkslide==5.1.0          # via -r requirements.in

Docker health check

How to run docker health checks?

!docker
HEALTHCHECK --interval=5s --timeout=3s \
  CMD curl -f http://0.0.0.0:8080/ || exit 1

Check health:

!bash
$ docker inspect --format "{{json .State.Health }}" <CID> | jq
{
  "Status": "unhealthy",
  "FailingStreak": 65,
  "Log": [
...

Build presentation

Install && build:

!bash
$ pip install -e .
$ pp-build
$ firefox index.html

Or in docker:

!bash
$ docker build -t app .
$ docker run -ti --rm -p 8080:8080 app
$ firefox http://0.0.0.0:8080

Thanks

Josip Delić

repository presentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_presi-1.1.3.tar.gz (5.8 kB view details)

Uploaded Source

Built Distributions

py_presi-1.1.3-py3.6.egg (5.3 kB view details)

Uploaded Source

py_presi-1.1.3-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file py_presi-1.1.3.tar.gz.

File metadata

  • Download URL: py_presi-1.1.3.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.9

File hashes

Hashes for py_presi-1.1.3.tar.gz
Algorithm Hash digest
SHA256 a04c990ed45312df7732a223c5964ba49383a02f6eda3fc124e1aa013b8dbe25
MD5 ebd87314b683fc9815b87f66740f240a
BLAKE2b-256 6d677514980f3416d312fdda04cc98ab82d1e01409bbbf6b96b059519c2fc2b6

See more details on using hashes here.

File details

Details for the file py_presi-1.1.3-py3.6.egg.

File metadata

  • Download URL: py_presi-1.1.3-py3.6.egg
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.9

File hashes

Hashes for py_presi-1.1.3-py3.6.egg
Algorithm Hash digest
SHA256 a2c94d4ec42467d1020343f2b8057462986a116e98d70af006e3b05a6c5f502d
MD5 be68583f2a7cabfce44d0b650d835a11
BLAKE2b-256 bf72ce8bf9b0119d2fc6e0a3d5ed8841d99102916d50753c941071e3be365fec

See more details on using hashes here.

File details

Details for the file py_presi-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: py_presi-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.9

File hashes

Hashes for py_presi-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 18feef811cb170ef78068489421b759e81ca5b0e01377f0a92fbce56768fb0fe
MD5 32f5c2daba37790808510e372e4db9b6
BLAKE2b-256 cd98335d62e6ad6088a7876986c3ef7dff5e99584f052b810038f5324e09a38f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page