Permalink
Browse files

Added various documents and added the settings into it's own settings…

… file

git-svn-id: http://opensource.washingtontimes.com/projects/public/django-supertagging/trunk@22 a3a5eddf-6203-49af-8a4a-b68c2cc3a614
  • Loading branch information...
1 parent 1217c08 commit ddcdfb040e354df558267222fd2c8ff42dd629a4 jsoares committed Feb 12, 2009
Showing with 290 additions and 62 deletions.
  1. +9 −0 AUTHORS
  2. +201 −0 LICENSE
  3. +4 −0 NOTICE
  4. +11 −0 README
  5. +6 −0 supertagging/admin.py
  6. +1 −1 supertagging/models.py
  7. +9 −11 supertagging/modules/__init__.py
  8. +28 −27 supertagging/modules/handlers.py
  9. +21 −23 supertagging/settings.py
View
@@ -0,0 +1,9 @@
+Project leader(s):
+
+ * Jose Soares (jsoares@washingtontimes.com)
+
+Project member(s):
+
+ * Corey Oordt (coordt@washingtontimes.com)
+ * Justin Quick (jquick@washingtontimes.com)
+ * Jonathan Hensley (jhensley@washingtontimes.com)
View
201 LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
View
4 NOTICE
@@ -0,0 +1,4 @@
+Django-Supertaggin
+Copyright 2009 The Washington Times
+
+The product includes software developed at The Washington Times (opensource.washingtontimes.com)
View
11 README
@@ -0,0 +1,11 @@
+Django - Super Tagging
+
+Inspired by django-tagging, this project came up when we wanted to
+automate content tagging. Using OpenCalais service we are able to retrieve
+a large array of data, including basic entities (tags) and relations (attributes
+about the tag).
+
+Prerequisites
+ - simplejson ( http://pypi.python.org/pypi/simplejson )
+ - python-calais 1.4+ ( http://code.google.com/p/python-calais/ )
+
View
@@ -1,4 +1,8 @@
from django.contrib import admin
+from django.contrib.contenttypes import generic
+from supertagging.models import SuperTag, SuperTaggedItem
+from django.contrib.contenttypes.models import ContentType
+
class SuperTagAdmin(admin.ModelAdmin):
list_display = ('name', 'slug', 'stype', 'properties' )
@@ -21,3 +25,5 @@ class SuperTagRelationAdmin(admin.ModelAdmin):
ordering = ('tag', )
search_fields = ('stype', 'name', 'tag')
list_filter = ('stype', 'name', )
+
+
View
@@ -380,7 +380,7 @@ class SuperTaggedItem(models.Model):
objects = SuperTaggedItemManager()
def __unicode__(self):
- return self.tag
+ return ''
class SuperTaggedRelationItem(models.Model):
@@ -12,14 +12,12 @@
except ImportError:
Calais = None
+from supertagging import settings
from supertagging.models import SuperTag, SuperTagRelation, SuperTaggedItem, SuperTaggedRelationItem
REF_REGEX = "^http://d.opencalais.com/(?P<key>.*)$"
-RESOLVE_KEYS = getattr(settings, 'SUPERTAGGING_RESOLVE_PROPERTY_KEYS', False)
-
-def process(api_key, field, data, obj, process_type='TEXT/RAW', user_directives={},
- processing_directives={}, process_relations=False, process_topics=False, exclusions=[]):
+def process(field, data, obj, process_type='TEXT/RAW'):
"""
Process the data.
"""
@@ -29,8 +27,8 @@ def process(api_key, field, data, obj, process_type='TEXT/RAW', user_directives=
# see open-calais.com for more information about user directives,
# and processing directives
c = Calais(api_key)
- c.user_directives.update(user_directives)
- c.processing_directives.update(processing_directives)
+ c.user_directives.update(settings.USER_DIR)
+ c.processing_directives.update(settings.PROCESSING_DIR)
c.processing_directives['contentType'] = process_type
# Analyze the text (data)
result = c.analyze(data)
@@ -45,10 +43,10 @@ def process(api_key, field, data, obj, process_type='TEXT/RAW', user_directives=
if hasattr(result, 'entities'):
entities = _processEntities(field, result.entities, obj, ctype, exclusions, process_type)
- if hasattr(result, 'relations') and process_relations:
+ if hasattr(result, 'relations') and settings.PROCESS_RELATIONS:
relations = _processRelations(field, result.relations, obj, ctype, process_type)
- if hasattr(result, 'topics') and process_topics:
+ if hasattr(result, 'topics') and settings.PROCESS_TOPICS:
topics = _processTopics(field, result.topics, obj, ctype)
def clean_up(obj):
@@ -59,7 +57,7 @@ def clean_up(obj):
SuperTaggedItem.objects.filter(content_type=cont_type, object_id=obj.pk).delete()
SuperTaggedRelationItem.objects.filter(content_type=cont_type, object_id=obj.pk).delete()
- # TODO, clean up tags that are no related items?
+ # TODO, clean up tags that have no related items?
# Same for relations?
def _processEntities(field, data, obj, ctype, exclusions, process_type):
@@ -74,7 +72,7 @@ def _processEntities(field, data, obj, ctype, exclusions, process_type):
pk = re.match(REF_REGEX, str(entity.pop('__reference'))).group('key')
stype = entity.pop('_type', '')
- if stype.lower() not in exclusions:
+ if stype.lower() not in settings.EXCLUSIONS:
name = entity.pop('name', '').lower()
slug = slugify(name)
try:
@@ -160,7 +158,7 @@ def _getEntityText(key):
"""
Try to resolve the entity given the key
"""
- if RESOLVE_KEYS:
+ if settings.RESOLVE_KEYS:
try:
r = SuperTag.objects.get(pk=key)
return r.name
Oops, something went wrong.

0 comments on commit ddcdfb0

Please sign in to comment.