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