Commits

Andrej Golcov  committed a0a958a Draft

adding sceleton for Bloodhound Relation plugin - towards BEP-0006

git-svn-id: https://svn.apache.org/repos/asf/bloodhound/trunk@146721813f79535-47bb-0310-9956-ffa450edef68

  • Participants
  • Parent commits 8c661d4

Comments (0)

Files changed (10)

File bloodhound_relations/CHANGES

+
+What's new in version 0.1.0
+---------------------------
+
+- 

File bloodhound_relations/MANIFEST.in

+
+include README CHANGES
+graft bhrelations/templates
+

File bloodhound_relations/README

+
+= Ticket Relations plugin for Apache(TM) Bloodhound =
+
+
+== Dependencies ==
+
+This plugin depends on the following components to be installed:
+
+
+  - [http:trac.edgewall.org Trac]  ,,Since version 
+    ''' 1.0.1 ''',, .
+
+
+== Configuration ==
+
+In order to enable [wiki:/En/Devel/BloodhoundTicketRelationsPlugin BloodhoundTicketRelationsPlugin] plugin,
+the only thing to do is to add the following lines to [wiki:TracIni trac.ini].
+
+{{{
+[components]
+bhrelations.* = enabled
+}}}
+
+== Bug / feature requests ==
+
+Existing bugs and feature requests for [wiki:/En/Devel/BloodhoundTicketRelationsPlugin BloodhoundTicketRelationsPlugin] are
+[query:status=new|assigned|reopened&keywords=~bep-0006 here].
+If you have any issues, please create a [/newticket?keywords=bep-0006 new ticket].
+

File bloodhound_relations/TESTING_README

+
+= Testing Bloodhound Search plugin =
+
+== Overview ==
+
+This plugin makes use of `setuptools` `test` command. Therefore all 
+test-support libraries needed to run the test suite should be installed 
+automatically (... considering the fact that they are listed in 
+`tests_require` and `install_requires` entries in `setup.ini` script ;).
+Recommended is the use of virtual Python environments. 
+
+== How to run tests ==
+
+All tests are written in files under `bhrelations/tests` folder 
+(sub-modules of `bhrelations.tests`) having names starting with prefix 
+`test_`. The following command should be enough so as to run tests 
+in one such module :
+
+{{{
+#!sh
+
+$ /path/to/python setup.py test -m bhrelations.tests.test_<something>
+
+}}}
+
+... where `<something>` should be replaced to match the name of an existing 
+file containing tests e.g.
+
+{{{
+#!sh
+
+$ /path/to/python setup.py test -m bhrelations.tests.test_report
+
+}}}
+
+== Continuous integration ==
+
+*TODO*
+
+== How do we run tests ==
+
+At present members of the team run tests on their computers as mentioned below :
+
+  - ''Python'' '''2.6''' virtual environment , Trac '''1.0.1''' .
+
+Besides there's a whole continuous integration infrastructure behind the 
+project (but that's TBD so far, should be documented later so that's in the 
+*TODO* list).
+

File bloodhound_relations/bhrelations/__init__.py

+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+
+#  Licensed to the Apache Software Foundation (ASF) under one
+#  or more contributor license agreements.  See the NOTICE file
+#  distributed with this work for additional information
+#  regarding copyright ownership.  The ASF licenses this file
+#  to you 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.
+

File bloodhound_relations/bhrelations/api.py

+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+
+#  Licensed to the Apache Software Foundation (ASF) under one
+#  or more contributor license agreements.  See the NOTICE file
+#  distributed with this work for additional information
+#  regarding copyright ownership.  The ASF licenses this file
+#  to you 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.
+

File bloodhound_relations/bhrelations/tests/__init__.py

+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+
+#  Licensed to the Apache Software Foundation (ASF) under one
+#  or more contributor license agreements.  See the NOTICE file
+#  distributed with this work for additional information
+#  regarding copyright ownership.  The ASF licenses this file
+#  to you 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.
+

File bloodhound_relations/setup.cfg

+#  Licensed to the Apache Software Foundation (ASF) under one
+#  or more contributor license agreements.  See the NOTICE file
+#  distributed with this work for additional information
+#  regarding copyright ownership.  The ASF licenses this file
+#  to you 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.
+
+[egg_info]
+tag_build = dev
+tag_date = 0
+tag_svn_revision = true
+
+[sdist]
+formats = gztar,bztar,ztar,tar,zip
+

File bloodhound_relations/setup.py

+#!/usr/bin/env python
+
+#  Licensed to the Apache Software Foundation (ASF) under one
+#  or more contributor license agreements.  See the NOTICE file
+#  distributed with this work for additional information
+#  regarding copyright ownership.  The ASF licenses this file
+#  to you 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.
+
+
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+DESC = """Ticket relations plugin for Apache(TM) Bloodhound.
+
+Add ticket relations functionality to Bloodhound sites.
+"""
+
+versions = [
+    (0, 4, 0),
+    (0, 5, 0),
+    (0, 6, 0),
+    ]
+
+latest = '.'.join(str(x) for x in versions[-1])
+
+status = {
+            'planning' :  "Development Status :: 1 - Planning",
+            'pre-alpha' : "Development Status :: 2 - Pre-Alpha",
+            'alpha' :     "Development Status :: 3 - Alpha",
+            'beta' :      "Development Status :: 4 - Beta",
+            'stable' :    "Development Status :: 5 - Production/Stable",
+            'mature' :    "Development Status :: 6 - Mature",
+            'inactive' :  "Development Status :: 7 - Inactive"
+         }
+dev_status = status["alpha"]
+
+cats = [
+      dev_status,
+      "Environment :: Plugins",
+      "Environment :: Web Environment",
+      "Framework :: Trac",
+      "Intended Audience :: Developers",
+      "Intended Audience :: Information Technology",
+      "Intended Audience :: Other Audience",
+      "Intended Audience :: System Administrators",
+      "License :: Unknown",
+      "Operating System :: OS Independent",
+      "Programming Language :: Python",
+      "Programming Language :: Python :: 2.5",
+      "Programming Language :: Python :: 2.6",
+      "Programming Language :: Python :: 2.7",
+      "Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries",
+      "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+      "Topic :: Internet :: WWW/HTTP :: WSGI",
+      "Topic :: Software Development :: Bug Tracking",
+      "Topic :: Software Development :: Libraries :: Application Frameworks",
+      "Topic :: Software Development :: Libraries :: Python Modules",
+      "Topic :: Software Development :: User Interfaces",
+    ]
+
+# Be compatible with older versions of Python
+from sys import version
+if version < '2.2.3':
+    from distutils.dist import DistributionMetadata
+    DistributionMetadata.classifiers = None
+    DistributionMetadata.download_url = None
+
+# Add the change log to the package description.
+chglog = None
+try:
+    from os.path import dirname, join
+    chglog = open(join(dirname(__file__), "CHANGES"))
+    DESC+= ('\n\n' + chglog.read())
+finally:
+    if chglog:
+        chglog.close()
+
+DIST_NM = 'BloodhoundRelationsPlugin'
+PKG_INFO = {'bhrelations' : ('bhrelations',                     # Package dir
+                            # Package data
+                            ['../CHANGES', '../TODO', '../COPYRIGHT',
+                              '../NOTICE', '../README', '../TESTING_README',
+                              'htdocs/*.*', 'htdocs/css/*.css',
+                              'htdocs/img/*.*', 'htdocs/js/*.js',
+                              'templates/*', 'default-pages/*'],
+                          ),
+            'bhrelations.tests' : ('bhrelations/tests',     # Package dir
+                            # Package data
+                            ['data/*.*'],
+                          ),
+            }
+
+ENTRY_POINTS = {
+    'trac.plugins': [
+        'bhrelations.api = bhrelations.api',
+    ],
+    }
+setup(
+    name=DIST_NM,
+    version=latest,
+    description=DESC.split('\n', 1)[0],
+    author = "Apache Bloodhound",
+    license = "Apache License v2",
+    url = "http://incubator.apache.org/bloodhound/",
+    requires = ['trac'],
+    install_requires = [
+        'setuptools>=0.6b1',
+        'Trac>=0.11',
+    ],
+    package_dir = dict([p, i[0]] for p, i in PKG_INFO.iteritems()),
+    packages = PKG_INFO.keys(),
+    package_data = dict([p, i[1]] for p, i in PKG_INFO.iteritems()),
+    include_package_data=True,
+    provides = ['%s (%s)' % (p, latest) for p in PKG_INFO.keys()],
+    obsoletes = ['%s (>=%s.0.0, <%s)' % (p, versions[-1][0], latest) \
+                  for p in PKG_INFO.keys()],
+    entry_points = ENTRY_POINTS,
+    classifiers = cats,
+    long_description= DESC
+    )
+

File installer/requirements-dev.txt

 -e ../bloodhound_theme
 TracPermRedirect
 -e ../bloodhound_search
+-e ../bloodhound_relations