Seagull Documentation - Read the Docs

1 Seagull DocumentationRelease Yamasaki Vukelic 21, 2016 Contents1 Guide requirements .. Seagull .. steps .. the configuration .. the styling .. the templates ..19iiiSeagull Documentation , Release is an open-source skinnable phot gallery app written in Python and released under the GNU General guide explains how to start, customize, and deploy Seagull in a production environment. Since Seagull is rela-tively simple in design, most of the space will be spent on the customization aspect. The guide is written in the tutorialstyle to ease new users into the matter, but basic knowledge of Python, HTML, and CSS will definitely go a long waytowards making the reading experience much Documentation , Release Software requirementsIn order to run Seagull on your machine, you will need to have a bunch of programs installed that Seagull depends of these programs are for running Seagull itself, some are for developing the skins.

2 This section is divided intosubsections so you can skip the parts you do not need at this time. You must, however, cover BasicsAt absolute minimum you will need to have Python or newer installed. Seagull specifically uses features that werenewly introduced in Python , so older versions will not work (not even older versions in the series).If you are on Linux, you should use your distro s package manager to install Python. In some distributions ( , ArchLinux), the defaultpythonpackage is Python On other distros, default is usually Python so the Python use a package namedpython3or something along those and Mac users can peruse the download page on Python is installed, check that you have the correct version.

3 Run the following command in the command line(command prompt):> python --versionPython some instances, you may need to refer to Python aspython3or the command line:> python3 --versionPython the rest of the guide, when you seepythonin the command examples, you will use the command namethat worked for you, be itpythonorpython3(and the same applies topipas you will see later on).Note:If your Linux distro does not ship the latest and greatest version, you will need to figure out a way to get thelatest version. For older releases of Ubuntu, for example, follow this advice.

4 Debian has Python in the unstablebranch. If you are going to eventually deploy Seagull yourself, it would probably be worthwhile to explore theseupgrades your Python install does not come with pip, the Python package manager, you will also need to install pip. Theversion of the pip package is not critical for using Seagull but asking for its version is a good way to test if it sinstalled:3 Seagull Documentation , Release > pip --versionpip from .. (python )Make sure that it says python in the result.

5 If it says something like python or any version other than ,then you probably installed pip for the wrong version of Python. For example, on Linux, pip for Python would bein a package namedpython3-pipor something similar. In some cases, the command itself may be different ( ,pip3instead ofpip). Software needed for skin developmentIf you intend to customize the built-in skins (but not strictly required if you just want to create a completely new skin),you will also need: NodeJS and NPM for CoffeeScript support (see this guide) Ruby and Ruby Gems for Compass support (see this guide)To verify the installs:> npm > gem versions are not really important here.

6 Once you have NodeJS, NPM, Ruby, and Ruby Gems installed, you willneed to install CoffeeScript and Compass. To install CoffeeScript with NPM, run this command:> npm install --global coffee-scriptNext install Compass using Ruby Gem:> gem install compassYou probably want to verify that these tools were installed correctly:> coffee --versionCoffeeScript version > compass --versionCompass (Polaris)Copyright (c) 2008-2016 Chris EppsteinReleased under the MIT is make a tax deductable donation for a worthy cause: Tools for working on the documentationIf you wish to hack at this guide, you will need to install Sphinx and the ReadTheDocs theme for Sphinx:> pip install sphinx sphinx-rtd-themeTo verify that Sphinx was installed:> sphinx-build --versionSphinx (sphinx-build) 1.

7 Guide contentsSeagull Documentation , Release Tools for working with the source codeThe Seagull source code can always be browsed through on GitHub, so making a local copy of the source code andtracking it is not strictly necessary. If you still wish to give it a try, here are the tools you will need: Git Installing SeagullOnce all the prerequisites are satisfied (see :doc:requirements), you can install Seagull Install from GitHubTo install Seagull on your computer as a package (as opposed to creating a local copy of the source, that is), you caninstall directly from the GitHub repository of the project:> pip install you need to know where it got installed, run the following command:> python -c 'import Seagull .

8 Print( )'/usr/ # or on Windows: c:\python35\lib\site-packages\ Clone the source codeIf you installed the tools for working with the source code in the :doc:requirements section, you now get a chance toput them to use. First you will need to clone the Git repository:> git clone into ' Seagull '..remote: Counting objects: 418, : Compressing objects: 100% (194/194), : Total 418 (delta 226), reused 377 (delta 185), pack-reused 0 Receiving objects: 73% (306/418), KiB | KiB/sReceiving objects: 100% (418/418), KiB | KiB/s, deltas: 100% (226/226), done.

9 > cd Seagull > mkvirtualenv seagullUsing base prefix '<path to python>'New python executable in <path to copy of python>Installing setuptools, pip, > pip install -e .Obtaining file://<path to cloned repository>Collecting bottle== (from Seagull == )Collecting bottle-streamline== (from Seagull == )Collecting confloader== (from Seagull == )..Later if you wish to update the source code Installing Seagull5 Seagull Documentation , Release > git reset --hard HEAD> git pull origin masterNote:If you wish to learn more about Git, there is plenty of material on the Git homepage, in the documentationsection, including introductory Verifying the installTo verify that Seagull was installed correctly, you can run this command.

10 > Seagull First stepsIn this section, we ll take Seagull for a quick step, and do some fairly basic customization , simply by manipulatingthe gallery Ignition!Let s quickly start up Seagull and see what that does. In your console, type:> seagullStarting SeagullRegistering SIGINT handlerRegistering SIGTERM handlerPreparing application to runAdded JS bundle: CSS bundle: , no gallery directory '/tmp/ Seagull -gallery'So that was a bit s missing a gallery folder at its default location, which is/tmp/ Seagull -gallery(orC:\tmp\ Seagull - galleryon Windows).