From 050d1408d2cbfdaaff35bb5d3821db424bcf7608 Mon Sep 17 00:00:00 2001
From: Alexey Zankevich <zancudero@gmail.com>
Date: Tue, 28 Jul 2015 14:01:30 +0300
Subject: [PATCH] added keywords

---
 README    | 109 ------------------------------------------------------
 setup.cfg |   2 +
 setup.py  |   1 +
 3 files changed, 3 insertions(+), 109 deletions(-)
 delete mode 100644 README
 create mode 100644 setup.cfg

diff --git a/README b/README
deleted file mode 100644
index 649519f..0000000
--- a/README
+++ /dev/null
@@ -1,109 +0,0 @@
-# Django ORM Sugar
-Sugar library to simplify Django querying
-
-## Overview 
-
-S - Django ORM Sugar
-
-This library tries to replace calls like:
-```python     
-SomeModel.objects.filter(user__profile__common_bucket__seq_count__gte=7)
-```
-    
-With more pythonic syntax
-```python
-from django_orm_sugar import S
-
-SomeModel.objects.filter(S.user.profile.common_bucket.seq_count >= 7)
-```
-      
-Not much shorter, but much more readable.
-
-
-## Queries
-General comparison actions generate related Q objects:  
-```python
->>> S.user.username == 'Bender Rodriguez'
-Q(user__username='Bender Rodriguez')
-
->>> S.user.age > 7
-Q(user__age__gt=7)
-
->>> S.user.age >= 7
-Q(user__age__gte=7)
-
->>> S.user.age < 7
-Q(user__age__lt=7)
-
->>> S.user.age <= 7
-Q(user__age__lte=7)
-```
-
-Filter by null (or not-null) fields
-```python
->>> S.user.favorite_movie.isnull(True)
-Q(user__favorite_movie__isnull=True)
-```
-
-Filter by fields matching a given list
-```python
->>> S.user.id.in_list([1, 2, 3])
-Q(user__id__in=[1, 2, 3])
-```
-   
-Filter by fields in range
-```python
->>> S.user.id.in_range(7, 10)
-Q(user__id__lte=7) & Q(user__id__gte=10)
-```
-    
-Common Django filter shortcuts
-```python
->>> S.user.username.iexact('Bender Rodriguez')
-Q(user__username__iexact='Bender Rodriguez')
-
->>> S.user.username.exact('Bender Rodriguez')
-Q(user__username__exact='Bender Rodriguez')
-
->>> S.user.username.contains('Rodriguez')
-Q(user__username__contains='Rodriguez')
-
->>> S.user.username.icontains('Rodriguez')
-Q(user__username__icontains='Rodriguez')
-```
-
-## Extending
-
-You can extend helper with your own methods. Let's say you need to create
-in_exc_range() helper, which will perform exclusive range filtering.
-  
-Step 1. Extend SugarQueryHelper class:
-```python
-from django_orm_sugar import SugarQueryHelper
-
-class RangedQueryHelper(SugarQueryHelper):
-    pass
-```
-
-Step 2. Create Helper Method
-```python
-class RangedQueryHelper(SugarQueryHelper):
-    def in_exc_range(self, min_value, max_value):
-        """
-        Unlike existing in_range method, filtering will be performed
-        excluding initial values. In other words - we will use "<" and ">"
-        comparison instead of "<=" and ">="
-        """
-        return (self < min_value) & (self > max_value)
-```
-
-Step 3. Initialize Helper Instance
-```python
-    S = RangedQueryHelper()  # can be done whether in function or module level
-```
-
-Step 4. Now you can use it in your code
-```python
->>> S.registration_date.in_exc_range(from_date, to_date)
-Q(registration_date__gt=from_date) & Q(registration_date__lt=to_date)
-```
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..224a779
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md
\ No newline at end of file
diff --git a/setup.py b/setup.py
index 5585738..abc0124 100644
--- a/setup.py
+++ b/setup.py
@@ -10,6 +10,7 @@
     author="Alexey Zankevich",
     author_email="alex.zankevich@gmail.com",
     description="Django ORM sugar library to simplify querying",
+    keywords=['Django', 'ORM', 'util', 'sugar'],
     license="MIT",
 )