##// END OF EJS Templates
readme update and fixed whoosh version 1.3.3 has error
marcink -
r727:0ab5deee beta
parent child Browse files
Show More
@@ -1,115 +1,113 b''
1 1
2 2 RhodeCode (RhodiumCode)
3 3 =======================
4 4
5 ``RhodeCode`` (formerly hg-app) is Pylons based repository management and
6 serving for mercurial_ and git_. It's similar to github or bitbucket, but
7 it's suppose to run as standalone app, it's open source and focuses more on
8 restricted access to repositories. There's no default free access to RhodeCode
9 You have to create an account in order to use the application. It's powered
10 by vcs_ library that we created to handle many various version control systems.
5 ``RhodeCode`` (formerly hg-app) is Pylons based Mercurial repository
6 browser/management with build in push/pull server and full text search. It's
7 similar to github or bitbucket, but it's suppose to run as standalone hosted
8 application, it's open source and focuses more on restricted access to
9 repositories. It's powered by vcs_ library that we created to handle many
10 various version control systems.
11 11
12 12 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
13 13
14 14 RhodeCode demo
15 15 --------------
16 16
17 17 http://hg.python-works.com
18 18
19 19 The default access is
20 20
21 21 - username: demo
22 22 - password: demo
23 23
24 24 Source code
25 25 -----------
26 26
27 27 Source code is along with issue tracker is available at
28 28 http://bitbucket.org/marcinkuzminski/rhodecode
29 29
30 30 Also a source codes can be obtained from demo RhodeCode instance
31 31 http://hg.python-works.com/rhodecode/summary
32 32
33 33 Instalation
34 34 -----------
35 35
36 36 Please visit http://packages.python.org/RhodeCode/installation.html
37 37
38 38
39 39 Features
40 40 --------
41 41
42 42 - Has it's own middleware to handle mercurial_ and git_ protocol request.
43 43 Each request can be logged and authenticated. Runs on threads unlikely to
44 44 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https
45 45 both on git_ and mercurial_
46 46 - Full permissions and authentication per project private/read/write/admin.
47 47 One account for web interface and mercurial_ push/pull/clone.
48 48 - Mako templates let's you customize look and feel of application.
49 49 - Beautiful diffs, annotations and source codes all colored by pygments.
50 50 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
51 51 - Admin interface with user/permission management. User activity journal logs
52 52 pulls, pushes, forks,registrations. Possible to disable built in hooks
53 53 - Server side forks, it's possible to fork a project and hack it free without
54 54 breaking the main.
55 55 - Full text search on source codes, search on file names. All powered by whoosh
56 56 and build in indexing daemons
57 57 (no external search servers required all in one application)
58 58 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
59 59 - Async tasks for speed and performance using celery_ (works without them too)
60 60 - Backup scripts can do backup of whole app and send it over scp to desired
61 61 location
62 62 - Setup project descriptions and info inside built in db for easy, non
63 63 file-system operations
64 64 - Added cache with invalidation on push/repo management for high performance and
65 65 always up to date data.
66 66 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
67 67
68 68
69 69 Incoming / Plans
70 70 ----------------
71 71
72 72 - code review (probably based on hg-review)
73 73 - full git_ support, with push/pull server
74 74 - project grouping
75 - anonymous access
76 -
75 - redmine integration
77 76 - commit based build in wiki system
78 77 - clone points and cloning from remote repositories into rhodecode
79 78 (git_ and mercurial_)
80 79 - more statistics and graph (global annotation + some more statistics)
81 80 - user customized activity dashboards
82 - some cache optimizations
83 81 - other cools stuff that i can figure out (or You can help me figure out)
84 82
85 83 License
86 84 -------
87 85
88 86 ``rhodecode`` is released under GPL_ license.
89 87
90 88
91 89 Mailing group Q&A
92 90 -----------------
93 91
94 92 http://groups.google.com/group/rhodecode
95 93
96 94
97 95 Documentation
98 96 -------------
99 97
100 98 Online documentation for current version is available at
101 99 http://packages.python.org/RhodeCode/.
102 100 You may also build documentation for yourself - go into ``docs/`` and run::
103 101
104 102 make html
105 103
106 104 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
107 105 .. _python: http://www.python.org/
108 106 .. _django: http://www.djangoproject.com/
109 107 .. _mercurial: http://mercurial.selenic.com/
110 108 .. _subversion: http://subversion.tigris.org/
111 109 .. _git: http://git-scm.com/
112 110 .. _celery: http://celeryproject.org/
113 111 .. _Sphinx: http://sphinx.pocoo.org/
114 112 .. _GPL: http://www.gnu.org/licenses/gpl.html
115 113 .. _vcs: http://pypi.python.org/pypi/vcs
@@ -1,98 +1,98 b''
1 1 from rhodecode import get_version
2 2 import sys
3 3 py_version = sys.version_info
4 4
5 5 requirements = [
6 6 "Pylons>=1.0.0",
7 7 "SQLAlchemy>=0.6.5",
8 8 "Mako>=0.3.6",
9 9 "vcs>=0.1.10",
10 10 "pygments>=1.3.0",
11 11 "mercurial>=1.6.4",
12 "whoosh>=1.3.3",
12 "whoosh>=1.3.1",
13 13 "celery>=2.1.3",
14 14 "py-bcrypt",
15 15 "babel",
16 16 ]
17 17
18 18 classifiers = ['Development Status :: 4 - Beta',
19 19 'Environment :: Web Environment',
20 20 'Framework :: Pylons',
21 21 'Intended Audience :: Developers',
22 22 'License :: OSI Approved :: BSD License',
23 23 'Operating System :: OS Independent',
24 24 'Programming Language :: Python', ]
25 25
26 26 if sys.version_info < (2, 6):
27 27 requirements.append("simplejson")
28 28 requirements.append("pysqlite")
29 29
30 30 #additional files from project that goes somewhere in the filesystem
31 31 #relative to sys.prefix
32 32 data_files = []
33 33
34 34 #additional files that goes into package itself
35 35 package_data = {'rhodecode': ['i18n/*/LC_MESSAGES/*.mo', ], }
36 36
37 37 description = ('Mercurial repository browser/management with '
38 38 'build in push/pull server and full text search')
39 39 #long description
40 40 try:
41 41 readme_file = 'README.rst'
42 42 changelog_file = 'docs/changelog.rst'
43 43 long_description = open(readme_file).read() + '/n/n' + \
44 44 open(changelog_file).read()
45 45
46 46 except IOError, err:
47 47 sys.stderr.write("[WARNING] Cannot find file specified as "
48 48 "long_description (%s)\n or changelog (%s) skipping that file" \
49 49 % (readme_file, changelog_file))
50 50 long_description = description
51 51
52 52
53 53 try:
54 54 from setuptools import setup, find_packages
55 55 except ImportError:
56 56 from ez_setup import use_setuptools
57 57 use_setuptools()
58 58 from setuptools import setup, find_packages
59 59 #packages
60 60 packages = find_packages(exclude=['ez_setup'])
61 61
62 62 setup(
63 63 name='RhodeCode',
64 64 version=get_version(),
65 65 description=description,
66 66 long_description=long_description,
67 67 keywords='rhodiumcode mercurial web hgwebdir gitweb git replacement serving hgweb rhodecode',
68 68 license='BSD',
69 69 author='Marcin Kuzminski',
70 70 author_email='marcin@python-works.com',
71 71 url='http://hg.python-works.com',
72 72 install_requires=requirements,
73 73 classifiers=classifiers,
74 74 setup_requires=["PasteScript>=1.6.3"],
75 75 data_files=data_files,
76 76 packages=packages,
77 77 include_package_data=True,
78 78 test_suite='nose.collector',
79 79 package_data=package_data,
80 80 message_extractors={'rhodecode': [
81 81 ('**.py', 'python', None),
82 82 ('templates/**.mako', 'mako', {'input_encoding': 'utf-8'}),
83 83 ('public/**', 'ignore', None)]},
84 84 zip_safe=False,
85 85 paster_plugins=['PasteScript', 'Pylons'],
86 86 entry_points="""
87 87 [paste.app_factory]
88 88 main = rhodecode.config.middleware:make_app
89 89
90 90 [paste.app_install]
91 91 main = pylons.util:PylonsInstaller
92 92
93 93 [paste.global_paster_command]
94 94 make-index = rhodecode.lib.indexers:MakeIndex
95 95 upgrade-db = rhodecode.lib.utils:UpgradeDb
96 96
97 97 """,
98 98 )
General Comments 0
You need to be logged in to leave comments. Login now