annotate README.rst @ 253:7effcce03192

docs update, developments serves statics as default
author Marcin Kuzminski <marcin@python-works.com>
date Fri, 04 Jun 2010 13:22:54 +0200
parents README.txt@782f0692b29c
children 85cbe7ad3402
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
1 ------------
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
2 Pylons based replacement for hgwebdir
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
3 ------------
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
4
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
5 Fully customizable, with authentication, permissions. Based on vcs library.
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
6 **Owerview**
224
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
7 - has it's own middleware to handle mercurial protocol request each request can
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
8 be logged and authenticated + threaded performance unlikely to hgweb
224
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
9 - mako templates let's you cusmotize look and feel of appplication.
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
10 - diffs annotations and source code all colored by pygments.
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
11 - admin interface for performing user/permission managments as well as repository
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
12 managment
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
13 - added cache with invalidation on push/repo managment for high performance and
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
14 always upto date data.
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
15 - rss /atom feed customizable
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
16 - future support for git
fdcef6ea3b55 Added readme, and changed version display
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
17 - based on pylons 1.0 / sqlalchemy 0.6
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
18
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
19
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
20 **Incoming**
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
21 - full permissions per project
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
22 - setup project descriptions and info into db
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
23 - git support (when vcs can handle it)
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
24
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
25 .. note::
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
26 This software is still in beta mode. I don't guarantee that it'll work.
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
27
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
28
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
29 -------------
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
30 Installation
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
31 -------------
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
32 - create new virtualenv and activate it
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
33 - download hg app and run python setup.py install
244
782f0692b29c fixed setup and install instructions
Marcin Kuzminski <marcin@python-works.com>
parents: 241
diff changeset
34 - goto build/ directory
782f0692b29c fixed setup and install instructions
Marcin Kuzminski <marcin@python-works.com>
parents: 241
diff changeset
35 - goto pylons_app/lib and run python db_manage.py it should create all
782f0692b29c fixed setup and install instructions
Marcin Kuzminski <marcin@python-works.com>
parents: 241
diff changeset
36 needed tables and an admin account.
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
37 - edit file repositories.config and change the [paths] where you keep your
244
782f0692b29c fixed setup and install instructions
Marcin Kuzminski <marcin@python-works.com>
parents: 241
diff changeset
38 mercurial repositories, remember about permissions for accessing this dir by
782f0692b29c fixed setup and install instructions
Marcin Kuzminski <marcin@python-works.com>
parents: 241
diff changeset
39 hg app.
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
40 - run paster serve development.ini
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
41 the app should be available at the 127.0.0.1:5000
244
782f0692b29c fixed setup and install instructions
Marcin Kuzminski <marcin@python-works.com>
parents: 241
diff changeset
42 - use admin account you created to login.