Mercurial > hg > agora-dellsystem
annotate README @ 77:d4e5ef15326a
Added django-openid-auth as a dependency
Also updated the README with instructions on installing the dependencies
using the pip-requirements file.
| author | dellsystem <ilostwaldo@gmail.com> |
|---|---|
| date | Fri, 17 Aug 2012 16:47:31 -0400 |
| parents | 9c1e26cc80e3 |
| children | 9d6b313af86f |
| 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 |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
8 Required external libraries: |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
9 |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
10 - Django registration |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
11 (http://bitbucket.org/ubernostrum/django-registration/) |
|
51
fd4c5b26b67a
Mention in README that pygments is also a required external lib
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
50
diff
changeset
|
12 - Pygments |
|
fd4c5b26b67a
Mention in README that pygments is also a required external lib
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
50
diff
changeset
|
13 (http://pygments.org/) |
|
77
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
14 - Django OpenID Auth |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
15 (http://pypi.python.org/pypi/django-openid-auth/) |
|
68
9c1e26cc80e3
Added django-threadedcomments to required external libraries in README
William Stevenson <yhvh2000@gmail.com>
parents:
56
diff
changeset
|
16 - Threaded Comments |
|
9c1e26cc80e3
Added django-threadedcomments to required external libraries in README
William Stevenson <yhvh2000@gmail.com>
parents:
56
diff
changeset
|
17 (https://github.com/HonzaKral/django-threadedcomments) |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
18 |
| 19 | 19 Quickstart for personal debugging: |
| 20 | |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
21 1) Install Django 1.2 or higher, Python 2.5 or higher, the |
| 50 | 22 external libraries, and probably any version of mercurial, |
|
33
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
23 SQLite3. On a Unix-based system, Python is probably already |
|
28a512881850
Several fixes. See detailed commit message.
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
28
diff
changeset
|
24 installed, the rest can be gotten from source or your operating |
|
77
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
25 system's package manager if it has one. If you have pip (the Python |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
26 package manager) installed, you can quickly install all the |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
27 dependencies at particular versions by running |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
28 |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
29 $ pip install -r pip-requirements |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
30 |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
31 It is recommended that you do this within a virtualenv to avoid |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
32 conflicts with system-wide packages. More information about |
|
d4e5ef15326a
Added django-openid-auth as a dependency
dellsystem <ilostwaldo@gmail.com>
parents:
68
diff
changeset
|
33 virtualenv is available at www.virtualenv.org. |
| 19 | 34 |
| 35 2) Clone this repository | |
| 36 | |
|
34
22d514498935
Move the configurable parts of settings.py into a conf file
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
33
diff
changeset
|
37 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
|
38 "agora.conf" (advanced users: modify this to suit your needs). |
| 19 | 39 |
| 40 4) Now run | |
| 41 | |
|
28
9f17312f3914
Fix a few silly typos
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
19
diff
changeset
|
42 $ python manage.py syncdb #Will create an empty database |
| 19 | 43 #(by default: sqlite3) |
| 44 | |
| 45 $ python manage.py runserver #Run a development webserver on port 8000 | |
| 46 | |
| 47 5) Point a browser to http://localhost:8000 | |
| 48 | |
| 49 6) Submit patches. ;-) | |
| 50 | |
| 51 Here's our TODO. At the moment, almost none of this is done. "I" in | |
| 52 the text below indicates "Jordi". | |
| 53 | |
| 54 -- Users can upload bundles of code. | |
| 55 | |
| 56 -- Bundles clearly indicate which free license they are using. I'm | |
| 57 thinking that it's reasonable to restrict allowable licenses to | |
| 58 GPL-compatibility. This is not a stringent requirement, and it | |
| 59 would simplify distribution with Octave. For the moment I'm | |
| 60 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
|
61 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
|
62 licenses is in place, but bundles aren't done yet. |
| 19 | 63 |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
64 -- 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
|
65 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
|
66 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
|
67 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
|
68 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
|
69 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
|
70 snippets. |
| 19 | 71 |
| 72 -- I'm thinking that optionally, I can setup bundles to also | |
| 73 create an hg repo if the uploader requests it, or existing hg | |
| 74 repos can be imported. | |
| 75 | |
| 76 -- When viewing a user's bundle, the bundle as a whole can be | |
| 77 ranked and commented upon by logged in users. The contents of | |
| 78 the bundle can also be browsed from the web without needing to | |
| 79 download the whole bundle. | |
| 80 | |
| 81 -- Logging in is required only to contribute to the site with | |
| 82 code, comments, ranking code. Everything else is public to | |
| 83 anyone. | |
| 84 | |
|
56
9659998da890
Update TODO in README with the work that's been done
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents:
51
diff
changeset
|
85 -- 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
|
86 names. **DONE** registration and profiles now do this. |
| 19 | 87 |
| 88 -- Bundles that are somehow deemed to be of high quality can | |
| 89 easily be pushed to Octave-forge (i.e. they've been "forged", | |
| 90 tempered, tested and tried). | |
| 91 | |
| 92 -- A user's landing page will indicate which bundles and snippets | |
| 93 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
|
94 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
|
95 aren't implemented yet. |
| 19 | 96 |
| 97 This README itself also admits patches. |