##// END OF EJS Templates
docs update, setup libs version bumps
marcink -
r676:bdd1ddd0 beta
parent child Browse files
Show More
@@ -1,103 +1,115 b''
1 1
2 2 RhodeCode (RhodiumCode)
3 3 =======================
4 4
5 5 ``RhodeCode`` (formerly hg-app) is Pylons based repository management and
6 6 serving for mercurial_ and git_. It's similar to github or bitbucket, but
7 7 it's suppose to run as standalone app, it's open source and focuses more on
8 8 restricted access to repositories. There's no default free access to RhodeCode
9 9 You have to create an account in order to use the application. It's powered
10 10 by vcs_ library that we created to handle many 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 Also a source codes can be obtained from demo rhodecode instance
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 - Has it's own middleware to handle mercurial_ protocol request. Each request
43 can be logged and authenticated. Runs on threads unlikely to hgweb You can
44 make multiple pulls/pushes simultaneous. Supports http/https
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
44 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https
45 both on git_ and mercurial_
45 46 - Full permissions and authentication per project private/read/write/admin.
46 47 One account for web interface and mercurial_ push/pull/clone.
47 48 - Mako templates let's you customize look and feel of application.
48 49 - Beautiful diffs, annotations and source codes all colored by pygments.
49 50 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
50 51 - Admin interface with user/permission management. User activity journal logs
51 52 pulls, pushes, forks,registrations. Possible to disable built in hooks
52 53 - Server side forks, it's possible to fork a project and hack it free without
53 54 breaking the main.
54 55 - Full text search on source codes, search on file names. All powered by whoosh
55 56 and build in indexing daemons
56 57 (no external search servers required all in one application)
57 58 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
58 59 - Async tasks for speed and performance using celery_ (works without them too)
59 60 - Backup scripts can do backup of whole app and send it over scp to desired
60 61 location
61 62 - Setup project descriptions and info inside built in db for easy, non
62 63 file-system operations
63 64 - Added cache with invalidation on push/repo management for high performance and
64 65 always up to date data.
65 66 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
66 67
67 68
68 Incoming
69 --------
69 Incoming / Plans
70 ----------------
70 71
71 72 - code review (probably based on hg-review)
72 73 - full git_ support, with push/pull server
74 - project grouping
75 - anonymous access
76 -
73 77 - commit based build in wiki system
74 78 - clone points and cloning from remote repositories into rhodecode
75 79 (git_ and mercurial_)
80 - more statistics and graph (global annotation + some more statistics)
81 - user customized activity dashboards
76 82 - some cache optimizations
77 83 - other cools stuff that i can figure out (or You can help me figure out)
78 84
79 85 License
80 86 -------
81 87
82 88 ``rhodecode`` is released under GPL_ license.
83 89
84 90
91 Mailing group Q&A
92 -----------------
93
94 http://groups.google.com/group/rhodecode
95
96
85 97 Documentation
86 98 -------------
87 99
88 100 Online documentation for current version is available at
89 101 http://packages.python.org/RhodeCode/.
90 102 You may also build documentation for yourself - go into ``docs/`` and run::
91 103
92 104 make html
93 105
94 106 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
95 107 .. _python: http://www.python.org/
96 108 .. _django: http://www.djangoproject.com/
97 109 .. _mercurial: http://mercurial.selenic.com/
98 110 .. _subversion: http://subversion.tigris.org/
99 111 .. _git: http://git-scm.com/
100 112 .. _celery: http://celeryproject.org/
101 113 .. _Sphinx: http://sphinx.pocoo.org/
102 114 .. _GPL: http://www.gnu.org/licenses/gpl.html
103 .. _vcs: http://pypi.python.org/pypi/vcs No newline at end of file
115 .. _vcs: http://pypi.python.org/pypi/vcs
@@ -1,49 +1,51 b''
1 1 .. _changelog:
2 2
3 3 Changelog
4 4 =========
5 5
6 6 1.1.0 (**2010-XX-XX**)
7 7 ----------------------
8 8 - git support with push/pull via RhodeCode web interface
9 9 - rewrite of internals for vcs >=0.1.9
10 - anonymous access
10 11 - performance upgrade for cached repos list - each repository has it's own
11 12 cache that's invalidated when needed.
12 13 - main page quick filter for filtering repositories
13 14 - more detailed action logger (based on hooks) with pushed changesets lists
14 15 and options to disable those hooks from admin panel
15 16 - a lot of fixes and tweaks for file browser
16 17 - introduced new enhanced changelog for merges that shows more accurate results
17 18 - gui optimizations, fixed application width to 1024px
19 - numerous small bugfixes
18 20
19 21 1.0.0 (**2010-11-02**)
20 22 ----------------------
21 23
22 24 - security bugfix simplehg wasn't checking for permissions on commands
23 25 other than pull or push.
24 26 - fixed doubled messages after push or pull in admin journal
25 27 - templating and css corrections, fixed repo switcher on chrome, updated titles
26 28 - admin menu accessible from options menu on repository view
27 29 - permissions cached queries
28 30
29 31 1.0.0rc4 (**2010-10-12**)
30 32 --------------------------
31 33
32 34 - fixed python2.5 missing simplejson imports (thanks to Jens BΓ€ckman)
33 35 - removed cache_manager settings from sqlalchemy meta
34 36 - added sqlalchemy cache settings to ini files
35 37 - validated password length and added second try of failure on paster setup-app
36 38 - fixed setup database destroy prompt even when there was no db
37 39
38 40
39 41 1.0.0rc3 (**2010-10-11**)
40 42 -------------------------
41 43
42 44 - fixed i18n during installation.
43 45
44 46 1.0.0rc2 (**2010-10-11**)
45 47 -------------------------
46 48
47 49 - Disabled dirsize in file browser, it's causing nasty bug when dir renames
48 50 occure. After vcs is fixed it'll be put back again.
49 51 - templating/css rewrites, optimized css.
@@ -1,122 +1,131 b''
1 1 .. _index:
2 2
3 3 Welcome to RhodeCode (RhodiumCode) documentation!
4 4 =================================================
5 5
6 6 ``RhodeCode`` (formerly hg-app) is Pylons based repository management and
7 7 serving for mercurial_ and git_. It's similar to github or bitbucket, but
8 8 it's suppose to run as standalone app, it's open source and focuses more on
9 9 restricted access to repositories. There's no default free access to RhodeCode
10 10 You have to create an account in order to use the application. It's powered
11 11 by vcs_ library that we created to handle many various version control systems.
12 12
13 13 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
14 14
15 15 RhodeCode demo
16 16 --------------
17 17
18 18 http://hg.python-works.com
19 19
20 20 The default access is
21 21
22 22 - username: demo
23 23 - password: demo
24 24
25 25 Source code
26 26 -----------
27 27
28 28 Source code is along with issue tracker is available at
29 29 http://bitbucket.org/marcinkuzminski/rhodecode
30 30
31 31 Also a source codes can be obtained from demo RhodeCode instance
32 32 http://hg.python-works.com/rhodecode/summary
33 33
34 34 Features
35 35 --------
36 36
37 37 - Has it's own middleware to handle mercurial_ and git_ protocol request.
38 38 Each request can be logged and authenticated. Runs on threads unlikely to
39 39 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https
40 40 both on git_ and mercurial_
41 41 - Full permissions and authentication per project private/read/write/admin.
42 42 One account for web interface and mercurial_ push/pull/clone.
43 43 - Mako templates let's you customize look and feel of application.
44 44 - Beautiful diffs, annotations and source codes all colored by pygments.
45 45 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
46 46 - Admin interface with user/permission management. User activity journal logs
47 47 pulls, pushes, forks,registrations. Possible to disable built in hooks
48 48 - Server side forks, it's possible to fork a project and hack it free without
49 49 breaking the main.
50 50 - Full text search on source codes, search on file names. All powered by whoosh
51 51 and build in indexing daemons
52 52 (no external search servers required all in one application)
53 53 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
54 54 - Async tasks for speed and performance using celery_ (works without them too)
55 55 - Backup scripts can do backup of whole app and send it over scp to desired
56 56 location
57 57 - Setup project descriptions and info inside built in db for easy, non
58 58 file-system operations
59 59 - Added cache with invalidation on push/repo management for high performance and
60 60 always up to date data.
61 61 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
62 62
63 63
64 64 .. figure:: images/screenshot1_main_page.png
65 65 :align: left
66 66
67 67 Main page of RhodeCode
68 68
69 69 .. figure:: images/screenshot2_summary_page.png
70 70 :align: left
71 71
72 72 Summary page
73 73
74 74
75 Incoming
76 --------
75 Incoming / Plans
76 ----------------
77 77
78 78 - code review (probably based on hg-review)
79 79 - full git_ support, with push/pull server
80 - project grouping
81 - anonymous access
82 -
80 83 - commit based build in wiki system
81 84 - clone points and cloning from remote repositories into rhodecode
82 85 (git_ and mercurial_)
83 86 - more statistics and graph (global annotation + some more statistics)
84 87 - user customized activity dashboards
85 88 - some cache optimizations
86 89 - other cools stuff that i can figure out (or You can help me figure out)
87 90
88 91 License
89 92 -------
90 93
91 94 ``rhodecode`` is released under GPL_ license.
92 95
93 96
97 Mailing group Q&A
98 -----------------
99
100 http://groups.google.com/group/rhodecode
101
102
94 103 Documentation
95 104 -------------
96 105
97 106 **Installation:**
98 107
99 108 .. toctree::
100 109 :maxdepth: 1
101 110
102 111 installation
103 112 upgrade
104 113 setup
105 114 changelog
106 115
107 116 Other topics
108 117 ------------
109 118
110 119 * :ref:`genindex`
111 120 * :ref:`search`
112 121
113 122 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
114 123 .. _python: http://www.python.org/
115 124 .. _django: http://www.djangoproject.com/
116 125 .. _mercurial: http://mercurial.selenic.com/
117 126 .. _subversion: http://subversion.tigris.org/
118 127 .. _git: http://git-scm.com/
119 128 .. _celery: http://celeryproject.org/
120 129 .. _Sphinx: http://sphinx.pocoo.org/
121 130 .. _GPL: http://www.gnu.org/licenses/gpl.html
122 131 .. _vcs: http://pypi.python.org/pypi/vcs
@@ -1,88 +1,88 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 "SQLAlchemy>=0.6.4",
7 "SQLAlchemy>=0.6.5",
8 8 "Mako>=0.3.5",
9 9 "vcs>=0.1.10",
10 10 "pygments>=1.3.0",
11 11 "mercurial>=1.6.4",
12 12 "whoosh>=1.3.1",
13 "celery>=2.1.2",
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 serving and browsing app'
38 38 #long description
39 39 try:
40 40 readme_file = 'README.rst'
41 41 long_description = open(readme_file).read()
42 42 except IOError, err:
43 43 sys.stderr.write("[WARNING] Cannot find file specified as "
44 44 "long_description (%s)\n skipping that file" % readme_file)
45 45 long_description = description
46 46
47 47
48 48 try:
49 49 from setuptools import setup, find_packages
50 50 except ImportError:
51 51 from ez_setup import use_setuptools
52 52 use_setuptools()
53 53 from setuptools import setup, find_packages
54 54 #packages
55 55 packages = find_packages(exclude=['ez_setup'])
56 56
57 57 setup(
58 58 name='RhodeCode',
59 59 version=get_version(),
60 60 description=description,
61 61 long_description=long_description,
62 62 keywords='rhodiumcode mercurial web hgwebdir replacement serving hgweb rhodecode',
63 63 license='BSD',
64 64 author='Marcin Kuzminski',
65 65 author_email='marcin@python-works.com',
66 66 url='http://hg.python-works.com',
67 67 install_requires=requirements,
68 68 classifiers=classifiers,
69 69 setup_requires=["PasteScript>=1.6.3"],
70 70 data_files=data_files,
71 71 packages=packages,
72 72 include_package_data=True,
73 73 test_suite='nose.collector',
74 74 package_data=package_data,
75 75 message_extractors={'rhodecode': [
76 76 ('**.py', 'python', None),
77 77 ('templates/**.mako', 'mako', {'input_encoding': 'utf-8'}),
78 78 ('public/**', 'ignore', None)]},
79 79 zip_safe=False,
80 80 paster_plugins=['PasteScript', 'Pylons'],
81 81 entry_points="""
82 82 [paste.app_factory]
83 83 main = rhodecode.config.middleware:make_app
84 84
85 85 [paste.app_install]
86 86 main = pylons.util:PylonsInstaller
87 87 """,
88 88 )
General Comments 0
You need to be logged in to leave comments. Login now