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