apys · PyPI

Wellcome to apys! A simple backend restful framework!

LANGUAGE

LIBRARIES

aiohttp - http client/server for asyncio

INSTALATION

Install python 3
- Windows - Link
- Ubuntu - sudo apt-get install python
- Fedora - sudo yum install python
- Arch - sudo pacman -S python
Install PIP - Python libraries manager
- Windows - Link
- Ubuntu - sudo apt-get install pip
- Fedora - sudo yum install pip
- Arch - sudo pacman -S pip
Install this framework using PIP
- pip install apys

INITIALIZATING PROJECT

$ apys --init

USING

DIRECTORIES

/config - json configuration files
/endpoints - backend endpoints
/utils - helper script files

CONFIG

Here are the configuration files used in the app. They will be send to the endpoint via param api.config

There are 3 special filenames: * prod.json - The oficial configuration file * dev.json - The development configuration file * local.json - The local configuration file (ignore in git)

You can also force it to use a configuration with the --config or -c option:

$ apys -s --config=my_config

Note: If no config file is choosen, they will work as following: the
api tries to load ``local.json``, then ``dev.json``, then
``prod.json``

The current config special properties are the following:

{
    "log": {
        "file": {
            "debug": "string or false //default=false. debug log file, false for sys.stdout",
            "error": "string or false //default=false. debug error file, false for sys.stderr",
            "(...)": "string or false //optional. you can specify any other log file, but you will have to tell the `api.debug` function to use it"
        },
        "color": "bool //default=true"
    },
    "server": {
        "port": "int //default=8888",
        "cors": "string or false //default=false"
    },
    "(...)": "(...) //you can add any other key and access it via `api.config['my_key']`"
}

ENDPOINTS

This will be your main dev dir

All files added here will be an endpoint automatically

i.e.: the file endpoints/hello/world.py will generate an endpoint /hello/world

The file’s code will be the following:

utils = [
    '[util1]',
    '[util2]'
]

def [method](req, api):
    [process]

Where [method] is the http request type: * post * get * put * delete * head * options * default - executed when a request is made for any of the above, but it is not implemented

[process] is what you wan the endpoint to do (your code)

[util1] and [util2] are the utils scripts (without .py)

req is aiohttp’s request, documentation

req has the params property to read the request body

api is the object that contains all api functionalities: * config - Configuration dictionary used in the actual scope * debug - function to log messages * error - function to log errors

UTILS

Python files with reusable code, to be called on endpoints.

It will be a normal cod, but with some special funcions:

init(api)

The function that will be executed on server startup
Only one time.

[method](req, api) - [method] being the type of http request

The function that will be called before every request to the function with the same name on the endpoint.
Any result should be stored on the variable `req`, because it is the only local variable on the request.

any(req, api)

The function that will be executed before any request.
Note: thids function will be executed before the later.

EXAMPLE

Look at the demos/ for examples:

hello_world: a simple hello world app, to learn the basics
multiple_endpoints: a simpler app that resembles more a final product
log_to_file: an example of logging in files

STARTING THE SERVER

There are 2 ways to start the server

Execute apys -s from terminal on your root project folder (Recomended)
Call the method start() from module apys.server (Only recomended if you need to do something before starting the server)

OBSERVATION

Both the framework and this page are in development, so, subjected to changes.

Version previous to v0.1.0 vas called pypolyback and used python 2.

Release files for apys 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for apys 0.4.1
File	Interpreter	ABI	Platform	Reset
apys-0.4.1-py3-none-any.whl 12.2 kB Oct 12, 2016	Python 3	none	any	Details

Release files / apys-0.4.1-py3-none-any.whl

Download URL	apys-0.4.1-py3-none-any.whl
Size	12.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2f3c0308bdb0083e94b2418681290aa2bde5c4fc89ba45c71098eb21b71a6585`
BLAKE2b-256 checksum How to use checksums	`31b4f6ac1e42a9f3ebf52d30ca4b3aed6d104ced43f766b4cce4c95fb7c53dea`
Upload date	Oct 12, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No