Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Peewee integration to Muffin framework

Project Description
Muffin Peewee
#############

.. _description:

Muffin Peewee -- Peewee ORM integration to Muffin framework.

.. _badges:

.. image:: http://img.shields.io/travis/klen/muffin-peewee.svg?style=flat-square
:target: http://travis-ci.org/klen/muffin-peewee
:alt: Build Status

.. image:: http://img.shields.io/pypi/v/muffin-peewee.svg?style=flat-square
:target: https://pypi.python.org/pypi/muffin-peewee

.. image:: http://img.shields.io/pypi/dm/muffin-peewee.svg?style=flat-square
:target: https://pypi.python.org/pypi/muffin-peewee

.. _contents:

.. contents::

.. _requirements:

Requirements
=============

- python >= 3.3

.. _installation:

Installation
=============

**Muffin Peewee** should be installed using pip: ::

pip install muffin-peewee

.. _usage:

Usage
=====

Add `muffin_peewee` to `PLUGINS` in your Muffin Application configuration.

Or install it manually like this: ::

db = muffin_peewee.Plugin(**{'options': 'here'})

app = muffin.Application('test')
app.install(db)


Options
-------

`PEEWEE_CONNECTION` -- connection string to your database (sqlite:///db.sqlite)

`PEEWEE_CONNECTION_PARAMS` -- Additional params for connection ({})

`PEEWEE_CONNECTION_MANUAL` -- Doesn't manage db connections automatically

`PEEWEE_MIGRATIONS_ENABLED` -- enable migrations (True)

`PEEWEE_MIGRATIONS_PATH` -- path to migration folder (migrations)

Queries
-------

::

@app.ps.peewee.register
class Test(peewee.Model):
data = peewee.CharField()


@app.register
def view(request):
return [t.data for t in Test.select()]

Manage connections
------------------
::

# Set configuration option `PEEWEE_CONNECTION_MANUAL` to True

# Use context manager
@app.register
def view(request):
with (yield from app.ps.peewee.manage()):
# Work with db
# ...


Migrations
----------

Create migrations: ::

$ muffin example:app create [NAME] [--auto]


Run migrations: ::

$ muffin example:app migrate [NAME] [--fake]


Rollback migrations: ::

$ muffin example:app rollback NAME


Load/Dump data to CSV
---------------------

Dump table `test` to CSV file: ::

$ muffin example:app csv_dump test


Load data from CSV file to table `test`: ::

$ muffin example:app csv_load test


.. _bugtracker:

Bug tracker
===========

If you have any suggestions, bug reports or
annoyances please report them to the issue tracker
at https://github.com/klen/muffin-peewee/issues

.. _contributing:

Contributing
============

Development of Muffin Peewee happens at: https://github.com/klen/muffin-peewee


Contributors
=============

* klen_ (Kirill Klenov)

.. _license:

License
=======

Licensed under a `MIT license`_.

If you wish to express your appreciation for the project, you are welcome to send
a postcard to: ::

Kirill Klenov
pos. Severny 8-3
MO, Istra, 143500
Russia

.. _links:

.. _MIT license: http://opensource.org/licenses/MIT
.. _klen: https://github.com/klen


Release History

Release History

This version
History Node

1.2.1

History Node

1.2.0

History Node

1.1.3

History Node

1.1.2

History Node

1.1.1

History Node

1.1.0

History Node

1.0.16

History Node

1.0.15

History Node

1.0.14

History Node

1.0.13

History Node

1.0.12

History Node

1.0.11

History Node

1.0.9

History Node

1.0.8

History Node

1.0.7

History Node

1.0.6

History Node

1.0.5

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

History Node

0.6.2

History Node

0.6.1

History Node

0.6.0

History Node

0.5.0

History Node

0.4.0

History Node

0.3.0

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.1

History Node

0.1.0

History Node

0.0.46

History Node

0.0.45

History Node

0.0.44

History Node

0.0.43

History Node

0.0.42

History Node

0.0.41

History Node

0.0.40

History Node

0.0.39

History Node

0.0.38

History Node

0.0.37

History Node

0.0.36

History Node

0.0.34

History Node

0.0.33

History Node

0.0.32

History Node

0.0.31

History Node

0.0.30

History Node

0.0.29

History Node

0.0.28

History Node

0.0.27

History Node

0.0.26

History Node

0.0.25

History Node

0.0.24

History Node

0.0.23

History Node

0.0.22

History Node

0.0.21

History Node

0.0.20

History Node

0.0.19

History Node

0.0.18

History Node

0.0.17

History Node

0.0.16

History Node

0.0.15

History Node

0.0.14

History Node

0.0.13

History Node

0.0.12

History Node

0.0.11

History Node

0.0.10

History Node

0.0.9

History Node

0.0.8

History Node

0.0.7

History Node

0.0.6

History Node

0.0.5

History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
muffin_peewee-1.2.1-py3-none-any.whl (13.7 kB) Copy SHA256 Checksum SHA256 py3 Wheel Jun 1, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting