Browse files

Added .gitignore file

  • Loading branch information...
1 parent c3cd8f5 commit 232d959940aa5a0c434f1a9a595fb01fa9b8fa4f Neville Newey committed May 10, 2010
Showing with 131 additions and 4 deletions.
  1. +2 −0 .gitignore
  2. +129 −4 README.txt
View
2 .gitignore
@@ -0,0 +1,2 @@
+*.pyc
+*~
View
133 README.txt
@@ -18,9 +18,14 @@ Note that this step is optional but higly recommended.
run virtualenv name_of_environment for example:
$ virtualenv abraxas_env
+me@myserver:~/webapps$ virtualenv abraxas_env
+New python executable in abraxas_env/bin/python
+Installing setuptools............done.
+
(If virtualenv is not installed then on Ubuntu the easiest way is
- to use easy_install to install it. If easy_install itself is not installed then first:
+ to use easy_install to install it. If easy_install itself is not
+ installed then first:
$ sudo apt-get install python-setuptools
then:
@@ -45,10 +50,130 @@ activated:
(abraxas_env)me@myserver:~/webapps$ git clone git://github.com/thakadu/Abraxas.git
-3) Within the abraxas directory setup the application:
+3) Within the Abraxas directory (created as a result of step 2 above):
+
+
+(abraxas_env)me@myserver:~/webapps$ cd Abraxas
+(abraxas_env)me@myserver:~/webapps/abraxas$ python setup.py install
+
+This will install all of the dependancies into the
+Virtual Python enviroment created in step 1.
+
+4) Create the database for Abraxas to use. If using MySQL:
+
+5) Create the database. If using MySQL:
+
+$ mysql -u root -p
+
+Once in the mysql environment:
+
+>>> create database abraxas default charset utf8;
+>>> grant all on abraxas.* to abraxas@localhost identified by 'password';
+
+Now exit the MySQL enviroment by hitting Ctrl-D
+
+6) Set the SQLAlchemy url in the prod.ini and/or the development.ini files.
+
+Fine the line that reads:
+sqlalchemy.url = mysql://abraxas:abraxas@tom:3306/abraxas
+and make sure it matches the database name, user name and password
+you used in step 5.
+
+7) Initialize the database:
+
+We are going to use the supplied SQLAlchemy-migrate
+scripts to generate the initial tables and indexes.
+In order to do this, we first place the database
+under version control:
+
+$ python db_repository/manage.py version_control mysql://abraxas:password@localhost:3306/abraxas
+
+Make sure to use the correct url for the database you created
+in step 6.
+
+This will create the migrate_version table in your database and set the
+initial version to 0.
+
+Now create a custom manage.py script by running the following command:
+
+$ migrate manage manage.py --repository=db_repository --url=mysql://abraxas:password@localhost:3306/abraxas
+
+This will create a new manage.py file in the current directory.
+
+Now 'upgrade' the database which will create all the initial tables
+and indexes.
+
+$ python manage.py upgrade
+
+You should see output similar to this:
+(abraxas_env)me@myserver:~/webapps/Abraxas$ python manage.py upgrade
+0 -> 1...
+done
+1 -> 2...
+done
+...
+...
+7 -> 8...
+done
+
+
+
+8) Load your initial feeds that you want to include in your
+Abraxas deployment. There is a loader script in the scripts
+directory called scripts/load_feeds.py
+It loads Feeds from a .csv file. Inside the data directory
+there are a couple of example .csv files. Create your
+own file from these, there are three fields, from
+left to right these are:
+
+a) Name of Feed
+b) Web Url (not the url of the feed but rather the website itself)
+c) Feed Url
+
+The data directory contains a few small example .csv files with some.
+
+The load_feeds.py script takes two parameters, the .ini file to
+use, which tells the script which database to load to and the
+.csv file which is where it loads the feeds from. By now your
+.ini file should already contain the correct database url you
+set in step 6.
+
+$ python scripts/load_feeds.py --ini=development.ini --filename=data/african_feeds.csv
+
+You can confirm that the feeds loaded by starting the mysql client
+and enterting the following query:
+
+$ mysql -u abraxas -p abraxas
+>>> select * from feed;
+
+If all went well you should see a list of the feeds from your .csv file.
+
+9) Fetch the items from your feeds.
+As with the load_feeds script the fetch_feeds script also
+takes the .ini filename as a parameter. In all cases
+the default value is development.ini so you might want
+to make sure you have the correct database set in your
+development.ini file.
+
+$ python scripts/fetch_feeds.py --ini=development.ini
+
+This should download feeds from the feed urls supplied
+for each feed and store each entry in the database.
+
+10) Tags the downloaded entries.
+
+Run the script scripts/tag_entries.py
+
+Again this takes the .ini file as a parameter:
+
+$ python scripts/tag_entries.py --ini=development.ini
+
+
+11) Now start your server:
+
+$ paster serve development.ini --daemon
+
-(abraxas_env)me@myserver:~/webapps$ cd abraxas
-(abraxas_env)me@myserver:~/webapps/abraxas$

0 comments on commit 232d959

Please sign in to comment.