Metadata-Version: 2.0
Name: tzo-silverstripe-installer
Version: 0.2.0
Summary: Automation script to create new Silverstripe site.
Home-page: http://git.timezoneone.com/timezoneone/tzo-silverstripe-installer
Author: Shawn Lin
Author-email: shawn@timezoneone.com
License: MIT
Keywords: timezoneone tzo silverstripe
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: requests

==========================
tzo-silverstripe-installer
==========================

Automation script to create new Silverstripe site.

Installation
------------

| Before being able to install this package, make sure you have python >= 3.5 installed first. If not, you can go to the official website to install it.
| 'pip' command will be available after python is installed.
| Then,

.. code:: shell

    pip install tzo-silverstripe-installer

| Please note it require python version >=3.5. For some environment, you might need to use "pip3" instead of "pip".

Usage
-----
.. code:: shell

    tzo-create <site-name> [--ss3] [--version version]

| By default, it will install latest stable version of SilverStripe 4.
| "site-name" required. It will applied to the site folder name and the repository name.
| "--ss3" optional. With this, it will install the latest version of SilverStripe 3.
| "--version" optional. The SilverStripe version to install. If this is provided, the option "--ss3" will be ignored.

How it works
------------

| It will ask you some information of the project. Input then hit enter key.
| The Gitlab private token will need to be entered only the first time. Then it will be saved to the file "$YOUR_HOME/.tzo_credentials".
| For windows user, it is recommended to use git-bash terminal to use this.

