Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #16

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
extras-mongoengine
MongoEngine Extras
==================

MongoEngine Extras - Field Types and any other wizardry.
The `extras-mongoengine` package provides the following extra fields for use on
MongoEngine `Document`s:

* `TimedeltaField` - a field for storing `datetime.timedelta` values.
* `LowerStringField` - a string field that transforms input strings to lowercase.
* `LowerEmailField` – a `LowerStringField` that also check if the string is valid according
to the MongoEngine email regex (`EmailField.EMAIL_REGEX`).
* `IntEnumField` - a field for storing Python 3.4 (or later) [Enum values] where the values
in the enum are `int`s.
* `StringEnumField` - a field for storing Python 3.4 (or later) [Enum values] where the values
in the enum are `str`s.

[Enum values]: https://docs.python.org/3/library/enum.html

To use the `IntEnumField` and `StringEnumField` fields on Python 2.* or Python <3.4
you have to install the `enum34` package.

`StringEnumField` example
-------------------------

from mongoengine import Document
from enum import Enum
from extras_mongoengine.fields import StringEnumField

class BeverageType(Enum):
Tea = 'TEA'
Coffee = 'COFFEE'

class Beverage(Document):
beverage_type = StringEnumField(BeverageType, default=BeverageType.Tea)