1. Tom Willis
  2. spazzer


Tom Willis  committed f3b0a72

updated docs to get things ready for 0.5 release

  • Participants
  • Parent commits abc4dd8
  • Branches default

Comments (0)

Files changed (4)

File CHANGES.txt

View file
 - feature complete with initial distribution
+- added manage interface
+- added search page
+- added pruning as part of scan command to remove records from the
+  index that no longer exist on the filesystem or are no longer being
+  managed by spazzer.
+- added some caching logic to scanning to speed things up a little
+- added a simple flash mp3 player to provide in browser playback
+- switched from package based running to instance based running via
+  paste and paste templates, this makes the documentation a bit easier
+  to understand and use if you are not a python developer. Also has
+  the nice side effect of not blowing away your database when you
+  re-install. i hope to find an easier way to install things in the
+  future.

File docs/conf.py

View file
 # built documents.
 # The short X.Y version.
-version = '0.0'
+version = '0.5'
 # The full version, including alpha/beta/rc tags.
-release = '0.0'
+release = '0.5'
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

File docs/index.rst

View file
 Creating an Instance
+Once spazzer has been successfully installed, you are ready to create
+an instance to run. The reason you create an instance to run is so
+that you can have multiple instances for different reasons or in the
+case of a machine used by many users, each user can have their own
+In other words, your view of your music collection does not have to
+include your 10 year old daughters Hannah Montana collection that she
+begged to buy you from amazon a while back.
+When spazzer was installed a new command should have been put in your
+path called "spazzer-create" running this command will walk you
+through creating an instance that you can run. ::
+  $ spazzer-create col
+Where "col" is the name you want to give to the directory that will
+store all your files necessary to run spazzer. You will be prompted to
+enter a port number, or you can accept the default (8088). When the
+command completes you will have a directory called whatever you named
 Running Spazzer
-If all the prerequisites have been met, and spazzer was installed
-successfully, a new command will be available called "spazzer", when
-run will launch a webserver on port 8088. ::
+Once you have created an instance you are ready to run your new
+spazzer site. Inside the directory where your spazzer instance was
+created there are some commands
-  $ spazzer
-You can then access it via a web browser at the following url. ::
+To run your spazzer instance you will need to run either "run.bat" on
+windows, or "run.sh" on presumably everything else. These commands are
+inside your spazzer instance directory
- http://localhost:8088/collection
+On Linux::
+  $ sh col/run.sh
+On Windows::
+  c:\> col\run.bat
+At this point you should have it running, you can then access it via 
+a web browser at the following url. If you accepted the default port
+setting ::
+ http://localhost:8088/
 Setting up your collection
 longer accessible, or are no longer contained in directories you have
 told spazzer to index.
+If ever you want to rescan your collection you can do it from the
+admin web page, or you can simply run the scan.bat command on windows
+or scan.sh on everything that's not windows.
+If you have a large collection being indexed it can take a while the
+first time through. 
 .. _`python`: http://python.org/download/
 .. _`wsgi`: http://wsgi.org

File setup.py

View file
 from setuptools import setup, find_packages
 here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, 'README.txt')).read()
+README = open(os.path.join(here, 'docs', 'index.rst')).read()
 CHANGES = open(os.path.join(here, 'CHANGES.txt')).read()
 setup(name = 'spazzer',
-      version = '0.0',
+      version = '0.5',
       description = 'spazzer',
       long_description = README + '\n\n' + CHANGES,
       classifiers = [