Python microservice framework :: pyrs¶

What is this package for¶

This package basically an umbrella for other packages. Ensure basic helpers for them like configuration, context, decorators, etc.

The ecosystem¶

Installation¶

$ pip install pyrs

Extending the exist functionality¶

The pyrs.ext and the pyrs itself are namespace packages. If you would like to extend an exist functionality of a package check that given package documentation for further information.

If you would like to implement a new funcionality, just create a new package inside pyrs package. Make sure the pyrs package still remain namespace package.

Dependencies¶

See requirements.txt. But The goal is less dependency as possible. Aim to work with python 2.7, 3.3, 3.4+ (tested agains them).

Important caveats¶

This code is in beta version. I working hard on write stable as possible API in the first place but while this code in 0.x version you should expect some major modification on the API.

Contribution¶

I really welcome any comments! I would be happy if you fork my code or create pull requests. I’ve already really strong opinions what I want to achieve and how, though any help would be welcomed.

Feel free drop a message to me!

Annotations¶

pyrs.env.annotations.annotate(_func=None, **kwargs)[source]¶

pyrs.env.annotations.ensure_meta(func, *args, **kwargs)[source]¶

pyrs.env.annotations.get_meta(func, name=None, default=None)[source]¶

Configuration module¶

class pyrs.env.configuration.Configuration(*bases)[source]¶

Bases: object

get(name, default=None)[source]¶

items()[source]¶

keys()[source]¶

upgrade(base)[source]¶

Context module¶

Context usage:

ctx = Context(value=1)
with ctx:
    call_a_function(ctx=ctx)

A bit more readable version:

ctx = Context(value=1)
with ctx.copy(value=2, new_value=3) as c:
    call_a_function(ctx=c)

class pyrs.env.context.Context(*args, **kwargs)[source]¶

Bases: thread._local

This is a thread safe stack based implementation of context.

_pop()[source]¶

_push()[source]¶

clear(*args, **kwargs)[source]¶

copy(*args, **kwargs)[source]¶

get(name, default=None)[source]¶

items()[source]¶

keys()[source]¶

update(*args, **kwargs)[source]¶

pyrs.env.context.ctx = <pyrs.env.context.Context object>¶

pyrs context

Language¶

The language of the comments, documentation, variable names, function names have to be English. Use syntax and spell checker against any of them. (It’s a bit controversial, because I made lots of spelling mistakes, but I welcome any improvements.)

PEP8¶

Every python code should be checked with some kind of pep8 checking tool. Please enable all validation (by default some of the disabled). None of the PEP8 errors or warning allowed in release version.

The following thumb rules are PEP8 conform.

Use single quote¶

Use single quote if it’s possible. Double quote only allowed if you can avoid escaping with it. If you have escaping both ways you should use single quote.

Importing¶

There should be alphabetically sorted import sections. The sections are:

• Future
• Python Standard Library
• Third Party
• Current Python Project
• Explicitly Local (from . import x)

You should import modules and packages rather than classes or functions if it could cause a conflict use as to make an alias. (In some cases importing a class or a function allowed but try to avoid)

from __future__ import absolute_import

import json
import os

import psycopg2
import werkzeug

from pyrs.swagger import tests

from . import base
from . import conf

Reporting a bug¶

You can report bugs or request any new feature on the official issue tracking of this project.

If you open an issue please give me detailed information about the bug. First of all I need to know which environment where you are using it. The most important think what I have to know which version what are you use. If it’s the master branch, please mention the commit hash. Second important think is the python version. Please describe how can I reproduce, give me a small example or a gist. If you can attach traceback would be really appreciated. Would help if you send me the pip freeze output and maybe the operating system (I hope the different OS cannot cause any problem).

Create pull request¶

I hope soon somebody help me to reach the project goals. If you would like to help me work on this project, please contact me first, we should agree about the planned work and how we should work together. I’ll review any pull request, though.

Any kind pull request, improvement should follow the coding standard of this framework. I plan to reach the %100 test coverage against the whole project. I’m using PEP8 validation against the whole code. Just tested and PEP8 conform code can be released.

Please see the Code styling documentation.