Metadata-Version: 2.0
Name: Pyjoyment
Version: 0.0.1
Summary: An asynchronous, event driver web framework for the Python programming language.
Home-page: http://github.com/dex4er/Pyjoyment
Author: Piotr Roszatycki
Author-email: piotr.roszatycki@gmail.com
License: Artistic
Download-URL: https://github.com/dex4er/Pyjoyment/archive/master.zip
Keywords: async framework html http mojo mojolicious pyjo pyjoyment tap test websocket wsgi
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Artistic License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server
Classifier: Topic :: Software Development :: Testing

[![Documentation Status](https://readthedocs.org/projects/pyjoyment/badge/?version=latest)](http://pyjoyment.readthedocs.org/en/latest/)

Pyjoyment
=========

An asynchronous, event driver web framework for the Python programming language.

Pyjoyment provides own reactor which handles I/O and timer events in its own
main event loop but it supports other loops, ie. libev, asyncio.

Pyjoyment uses intensively own event emmiter which should be familiar for
Node.js programmers.

It provides tool set for parsing and creating HTTP messages and HTML documents.
It also supports WSGI interface.

Pyjoyment is compatible with Python 2.7+, Python 3.3+ and PyPy 2.4+. It doesn't
require any external libraries or compilers.

See http://www.pyjoyment.net/

Pyjoyment is based on [Mojolicious](http://mojolicio.us): a next generation
web framework for the Perl programming language.


Status
======

Early developement stage. Implemented already:

  * WSGI adapter
  * HTTP standalone async-io server
  * WebSockets client and server
  * HTTP user agent with TLS/SSL support
  * JSON pointers implementation based on RFC6901
  * Embedded files loader
  * HTML/XML DOM parser with CSS selectors
  * URL parser with container classes for URL, path and querystring
  * Non-blocking TCP client and server
  * Simple logging object
  * Synchronizer and sequentializer of multiple events
  * Main event loop which handle IO and timer events
  * Event emitter with subscriptions
  * Low level event reactor based on select(2) and poll(2)
  * Convenient functions and classed for unicode and byte strings and lists
  * Lazy properties for objects
  * Test units with API based on Perl's Test::More and TAP protocol


Examples
========

Web scraping
------------

```python
import Pyjo.UserAgent
from Pyjo.String.Unicode import u

tx = Pyjo.UserAgent.new().get('https://html.spec.whatwg.org')
for n in tx.res.dom('#named-character-references-table tbody > tr').each():
    u(n.at('td > code').text + ' ' + n.children('td')[1].text).trim().say()
```


URL manipulation
----------------

```python
import Pyjo.URL
from Pyjo.String.Unicode import u

# 'ssh+git://git@github.com/dex4er/Pyjoyment.git'
url = Pyjo.URL.new('https://github.com/dex4er/Pyjoyment')
print(url.set(scheme='ssh+git', userinfo='git', path=u(url.path) + '.git'))

# 'http://metacpan.org/search?q=Mojo::URL&size=20'
print(Pyjo.URL.new('http://metacpan.org/search')
      .set(query={'q': 'Mojo::URL', 'size': 20}))
```


Non-blocking TCP client/server
------------------------------

```python
import Pyjo.IOLoop


# Listen on port 3000
@Pyjo.IOLoop.server(port=3000)
def server(loop, stream, cid):

    @stream.on
    def read(stream, chunk):
        # Process input chunk
        print("Server: {0}".format(chunk.decode('utf-8')))

        # Write response
        stream.write(b"HTTP/1.1 200 OK\x0d\x0a\x0d\x0a")

        # Disconnect client
        stream.close_gracefully()


# Connect to port 3000
@Pyjo.IOLoop.client(port=3000)
def client(loop, err, stream):

    @stream.on
    def read(stream, chunk):
        # Process input
        print("Client: {0}".format(chunk.decode('utf-8')))

    # Write request
    stream.write(b"GET / HTTP/1.1\x0d\x0a\x0d\x0a")


# Add a timer
@Pyjo.IOLoop.timer(3)
def timeouter(loop):
    print("Timeout")
    # Shutdown server
    loop.remove(server)


# Start event loop
Pyjo.IOLoop.start()
```


Standalone HTTP server serving embedded template file
------------------------------------------------------

```python
# -*- coding: utf-8 -*-

import Pyjo.Server.Daemon
import Pyjo.URL

from Pyjo.Loader import embedded_file
from Pyjo.Util import b, u

import sys


opts = dict([['address', '0.0.0.0'], ['port', 3000]] + list(map(lambda a: a.split('='), sys.argv[1:])))
listen = str(Pyjo.URL.new(scheme='http', host=opts['address'], port=opts['port']))

daemon = Pyjo.Server.Daemon.new(listen=[listen])
daemon.unsubscribe('request')


# Embedded template file
DATA = u(r'''
@@ index.html.tpl
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Pyjoyment</title>
</head>
<body>
<h1>♥ Pyjoyment ♥</h1>
<h2>This page is served by Pyjoyment framework.</h2>
<p>{method} request for {path}</p>
</body>
</html>
''')


@daemon.on
def request(daemon, tx):
    # Request
    method = tx.req.method
    path = tx.req.url.path

    # Template
    template = embedded_file(sys.modules[__name__], 'index.html.tpl')

    # Response
    tx.res.code = 200
    tx.res.headers.content_type = 'text/html; charset=utf-8'
    tx.res.body = b(template.format(**locals()))

    # Resume transaction
    tx.resume()


daemon.run()
```


