Mercurial > kallithea
annotate README.rst @ 603:95a502d94860
removed soon deprecated walk method on repository instance
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Mon, 18 Oct 2010 01:14:40 +0200 |
parents | 5c734b99c4db |
children | 60a4aabf6aa6 |
rev | line source |
---|---|
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
1 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
2 RhodeCode (RhodiumCode) |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
3 ======================= |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
4 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
5 ``RhodeCode`` (formerly hg-app) is Pylons based repository management and |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
6 serving for mercurial_. It's similar to github or bitbucket, but it's suppose to run |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
7 as standalone app, it's open source and focuses more on restricted access to repositories |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
8 There's no default free access to RhodeCode You have to create an account in order |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
9 to use the application. It's powered by vcs_ library that we created to handle |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
10 many various version control systems. |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
11 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
12 RhodeCode uses `Semantic Versioning <http://semver.org/>`_ |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
13 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
14 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
15 RhodeCode demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
16 -------------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
17 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
18 http://hg.python-works.com |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
19 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
20 The default access is |
254 | 21 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
22 - username: demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
23 - password: demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
24 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
25 Source code |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
26 ----------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
27 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
28 Source code is along with issue tracker is available at |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
29 http://bitbucket.org/marcinkuzminski/rhodecode |
254 | 30 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
31 Also a source codes can be obtained from demo rhodecode instance |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
32 http://hg.python-works.com/rhodecode/summary |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
33 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
34 Instalation |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
35 ----------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
36 |
576
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
37 Please visit http://packages.python.org/RhodeCode/installation.html |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
38 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
39 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
40 Features |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
41 -------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
42 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
43 - Has it's own middleware to handle mercurial_ protocol request. Each request can |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
44 be logged and authenticated. Runs on threads unlikely to hgweb You can make |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
45 multiple pulls/pushes simultaneous |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
46 - Full permissions and authentication per project private/read/write/admin. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
47 One account for web interface and mercurial_ push/pull/clone. |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
48 - Mako templates let's you customize look and feel of application. |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
49 - Beautiful diffs, annotations and source codes all colored by pygments. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
50 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
51 - Admin interface with user/permission management. User activity journal logs |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
52 pulls, pushes, forks,registrations. Possible to disable built in hooks |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
53 - Server side forks, it's possible to fork a project and hack it free without |
549
f99075170eb4
more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents:
547
diff
changeset
|
54 breaking the main. |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
55 - Full text search on source codes, search on file names. All powered by whoosh |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
56 and build in indexing daemons |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
57 (no external search servers required all in one application) |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
58 - Rss / atom feeds, gravatar support, download sources as zip/tarballs |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
59 - Async tasks for speed and performance using celery_ (works without them too) |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
60 - Backup scripts can do backup of whole app and send it over scp to desired |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
61 location |
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
62 - Setup project descriptions and info inside built in db for easy, non |
290
702c7e565c56
docs update, version bump
Marcin Kuzminski <marcin@python-works.com>
parents:
254
diff
changeset
|
63 file-system operations |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
64 - Added cache with invalidation on push/repo management for high performance and |
540
efbab97c3aca
fixed some spelling mistakes
Marcin Kuzminski <marcin@python-works.com>
parents:
523
diff
changeset
|
65 always up to date data. |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
66 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite |
0 | 67 |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
68 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
69 Incoming |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
70 -------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
71 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
72 - code review (probably based on hg-review) |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
73 - git_ support (when vcs_ can handle it - it's almost there !) |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
74 - commit based build in wiki system |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
75 - clone points and cloning from remote repositories into rhodecode (git_ and mercurial_) |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
76 - some cache optimizations |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
77 - other cools stuff that i can figure out (or You can help me figure out) |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
78 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
79 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
80 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
81 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
82 ``rhodecode`` is released under GPL_ license. |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
83 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
84 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
85 Documentation |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
86 ------------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
87 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
88 Online documentation for current version is available at |
576
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
89 http://packages.python.org/RhodeCode/. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
90 You may also build documentation for yourself - go into ``docs/`` and run:: |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
91 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
92 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
93 |
576
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
94 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
95 .. _python: http://www.python.org/ |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
96 .. _django: http://www.djangoproject.com/ |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
97 .. _mercurial: http://mercurial.selenic.com/ |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
98 .. _subversion: http://subversion.tigris.org/ |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
99 .. _git: http://git-scm.com/ |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
100 .. _celery: http://celeryproject.org/ |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
101 .. _Sphinx: http://sphinx.pocoo.org/ |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
102 .. _GPL: http://www.gnu.org/licenses/gpl.html |
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
103 .. _vcs: http://pypi.python.org/pypi/vcs |