/ 
WWW-Shopify-Tools-Themer-0.11
River stage zero No dependents
/ shopify-themer.pl

NAME

shopify-themer.pl - Supports the pushing and pulling of themes from a shopify store.

SYNOPSIS

shopify-themer.pl action [options]

action		Action can be one of several things.
	
		info
		Spits out a bunch of theme information in JSON form.
		Mainly used for debugging, and gedit integration.

		pullAll
		Pulls all themes from the shop

		pushAll
		Pushes all assets from all themes.

		push <ID/Name>
		Pushes all assets from the specified theme.

		pull <ID/Name>
		Pulls all assets form the specified theme.
		
		activate <ID/Name>
		Sets the specified theme as the main theme.
		
		watch <ID/Name>
		Watches the specified folder for changes,
		and then pushes those changes when necessary.
		If an ID or name is specified, it only
		watches that folder.

		installGedit
		Checks for gedit on the system and then
		installs the appropriate plugin into
		the gedit configuration folder.
		
		interactive
		Causes the script to be interactive; useful if
		you want to do something non-transactional,
		like continuous interaction with gedit. Will
		drop to a command line, and await the above
		actions. To exit, type exit.

--help		Displays this messaqge.
--fullhelp	Displays the full pod doc.

--wd		Sets the working directory to be something other
		than .
--interval	Sets the interval of time that the 'watch' command
		checks files at. Default is 1 second.

This following three parameters only need to be speciefied once
per working directory, as it will be saved in a hidden file in
that directory.

--url		Sets the shop url.
--api_key	Sets the api key of your private application.
--email		Sets the email you want to log in with.
--password	Either your private application's password when
		used with api_key, or your account's password
		when used with email.

DESCRIPTION

Shopify themer is a simple script which uses WWW::Shopify::Private and WWW::Shopify to fetch themes and assets from a Shopify store. It is meant to be used as either a standalone application, or integrated with Gedit as a plugin. It also has the ability to fetch/push pages from the Shopify store.

The gedit plugin is written in python, but ultimately is simply a wrapper around this script. Currently, support is limited to those OSs which can make symlinks and can install gedit. This means that it should also work (experimentally) on Windows and Mac. The system is mainly tested on Linux, so support for Linux is definitely higher priority than for other systmes.

Normally, you only have to specify the shop url, api key/email and password once per working directory/site. Don't try and create multiple site themes in the same directory as this is a _BAD_ _IDEA_.

The Shopify shop is the ultimate arbitrator of what is the 'final' version of a file; this makes good sense when multiple people are working on a shop, but may be somewhat annoying. What this means, is that:

For pushing: Files that are locally changed, and remotely not, will be pushed. Files that are locally changed, and remotely changed, will not be pushed. Files that are locally unchanged will only be pushed if the file is missing on the server.

For pulling: Files that are locally and remotely changed will be overwritten locally, so keep an eye out for this. Files that are locally not, and remotely chagned will be overritten locally. Files that are not present locally and remotely present will be pulled.

SEE ALSO

WWW::Shopify, WWW::Shopify::Private

AUTHOR

Adam Harrison (adamdharrison@gmail.com)

LICENSE

Copyright (C) 2013 Adam Harrison

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.