Mercurial > agora
annotate README @ 155:6b08da550214
Mention --distribute flag for virtualenv in readme
| author | dellsystem <ilostwaldo@gmail.com> |
|---|---|
| date | Mon, 15 Oct 2012 01:33:06 -0400 |
| parents | c7be7def8b57 |
| children |
| rev | line source |
|---|---|
| 19 | 1 Agora Octave is (or will be) a Django-based website for rapid |
|
28
9f17312f3914
Fix a few silly typos
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
19
diff
changeset
|
2 collaboration related to GNU Octave. It is released under the terms of |
|
9f17312f3914
Fix a few silly typos
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
19
diff
changeset
|
3 the Affero General Public License version 3 as published by the Free |
|
43
44b9f749cdb0
Add license information
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
34
diff
changeset
|
4 Software Foundation, or at your option, any later version. Agora also |
|
44b9f749cdb0
Add license information
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
34
diff
changeset
|
5 includes other software under a different BSD-like license. For |
|
44b9f749cdb0
Add license information
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
34
diff
changeset
|
6 details consult LICENSE. |
| 19 | 7 |
|
151
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
8 See the pip-requirements file for a list of required external libraries. |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
9 |
| 19 | 10 Quickstart for personal debugging: |
| 11 | |
|
151
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
12 1) Install Python 2.5 or higher, the external libraries, and probably any |
|
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
13 version of mercurial, SQLite3. On a Unix-based system, Python is probably |
|
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
14 already installed, the rest can be gotten from source or your operating |
|
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
15 system's package manager if it has one. If you have pip (the Python package |
|
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
16 manager) installed, you can quickly install all the dependencies at |
|
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
17 particular versions by running |
|
77
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
18 |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
19 $ pip install -r pip-requirements |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
20 |
|
155
6b08da550214
Mention --distribute flag for virtualenv in readme
dellsystem <ilostwaldo@gmail.com>
parents:
151
diff
changeset
|
21 It is recommended that you do this within a virtualenv to avoid |
|
6b08da550214
Mention --distribute flag for virtualenv in readme
dellsystem <ilostwaldo@gmail.com>
parents:
151
diff
changeset
|
22 conflicts with system-wide packages. More information about |
|
6b08da550214
Mention --distribute flag for virtualenv in readme
dellsystem <ilostwaldo@gmail.com>
parents:
151
diff
changeset
|
23 virtualenv is available at www.virtualenv.org. |
|
6b08da550214
Mention --distribute flag for virtualenv in readme
dellsystem <ilostwaldo@gmail.com>
parents:
151
diff
changeset
|
24 |
|
6b08da550214
Mention --distribute flag for virtualenv in readme
dellsystem <ilostwaldo@gmail.com>
parents:
151
diff
changeset
|
25 If you do use virtualenv, you may have tocreate the virtualenv with the |
|
6b08da550214
Mention --distribute flag for virtualenv in readme
dellsystem <ilostwaldo@gmail.com>
parents:
151
diff
changeset
|
26 --distribute flag, to avoid problems with installing distribute. |
| 19 | 27 |
| 28 2) Clone this repository | |
| 29 | |
|
34
22d514498935
Move the configurable parts of settings.py into a conf file
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
33
diff
changeset
|
30 3) In the cloned repository, copy "agora-example.conf" to |
|
22d514498935
Move the configurable parts of settings.py into a conf file
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
33
diff
changeset
|
31 "agora.conf" (advanced users: modify this to suit your needs). |
| 19 | 32 |
| 33 4) Now run | |
| 34 | |
|
28
9f17312f3914
Fix a few silly typos
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
19
diff
changeset
|
35 $ python manage.py syncdb #Will create an empty database |
| 19 | 36 #(by default: sqlite3) |
| 37 | |
| 38 $ python manage.py runserver #Run a development webserver on port 8000 | |
|
151
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
39 $ python manage.py celeryd --settings=settings # Start the celery |
|
c7be7def8b57
Bundles! (basic functionality)
dellsystem <ilostwaldo@gmail.com>
parents:
103
diff
changeset
|
40 # session (mandatory) |
| 19 | 41 |
| 42 5) Point a browser to http://localhost:8000 | |
| 43 | |
| 44 6) Submit patches. ;-) | |
| 45 | |
| 46 Here's our TODO. At the moment, almost none of this is done. "I" in | |
| 47 the text below indicates "Jordi". | |
| 48 | |
| 49 -- Users can upload bundles of code. | |
| 50 | |
| 51 -- Bundles clearly indicate which free license they are using. I'm | |
| 52 thinking that it's reasonable to restrict allowable licenses to | |
| 53 GPL-compatibility. This is not a stringent requirement, and it | |
| 54 would simplify distribution with Octave. For the moment I'm | |
| 55 considering that this might be relaxed and any license approved | |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
56 by the OSI or FSF should be ok. **DONE** The basic framework for |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
57 licenses is in place, but bundles aren't done yet. |
| 19 | 58 |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
59 -- Additionally, there's a place to post quick snippets. They'll be |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
60 under a default free license that the user indicates in their |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
61 preferences. Usually only single bits of code go in there. |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
62 Responding with more snippets will be facilitated. **DONE** |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
63 Except for the license part. I'm changing my mind about this, |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
64 perhaps it's too pedantic to demand clear licenses on code |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
65 snippets. |
| 19 | 66 |
| 67 -- I'm thinking that optionally, I can setup bundles to also | |
| 68 create an hg repo if the uploader requests it, or existing hg | |
| 69 repos can be imported. | |
| 70 | |
| 71 -- When viewing a user's bundle, the bundle as a whole can be | |
| 72 ranked and commented upon by logged in users. The contents of | |
| 73 the bundle can also be browsed from the web without needing to | |
| 74 download the whole bundle. | |
| 75 | |
| 76 -- Logging in is required only to contribute to the site with | |
| 77 code, comments, ranking code. Everything else is public to | |
| 78 anyone. | |
| 79 | |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
80 -- Users are encouraged but not required to provide real |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
81 names. **DONE** registration and profiles now do this. |
| 19 | 82 |
| 83 -- Bundles that are somehow deemed to be of high quality can | |
| 84 easily be pushed to Octave-forge (i.e. they've been "forged", | |
| 85 tempered, tested and tried). | |
| 86 | |
| 87 -- A user's landing page will indicate which bundles and snippets | |
| 88 this user has uploaded as well as whatever personal information | |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
89 the user would like to provide. **DONE** Except that bundles |
|
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
90 aren't implemented yet. |
| 19 | 91 |
| 92 This README itself also admits patches. |