Skip to content
Snippets Groups Projects
README.md 2.21 KiB
Newer Older
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed

Giorgos Korfiatis's avatar
Giorgos Korfiatis committed

This is a syncing client for object storage.

## Installation and Packaging
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed

This will help you to install `agkyra` from source.
You need to have Python 2.7 installed. If it is not provided by your
operating system, visit `https://www.python.org/downloads/`.

### Installation process

1. Run `python configure.py <platform>`. Paramater `platform` can be
   one of `win64, win32, osx64, osx32, linux64, linux32`. This will
   download `NW.js` and copy it into the source tree. It will also
   copy SSL certificate from `certifi` package.

2. Run `python setup.py install` (or `develop`).

* Note that on Windows with Python >=2.7.9 this may fail with an SSL
  verification error. If so, visit `https://pypi.python.org` with Internet
  Explorer. You will be prompted to accept the website's certificate. Do so
  and then retry step 2.

### Packaging

A package for Windows, OSX and Linux, that fully contains dependencies and
the Python framework can be created with PyInstaller.

1. Run `pip install pyinstaller`.

* Note: On Linux, we currently need the development version of PyInstaller.
  Get the code from `https://github.com/pyinstaller/pyinstaller`. No
  installation is needed: `pyinstaller.py` can directly run from the repo's
  root directory.

* Note: On Windows, PyWin32 is a prerequisite. Visit
  `http://sourceforge.net/projects/pywin32/files/` and pick the appropriate
  version for your Python installation.

3. Run `pyinstaller agkyra.spec`. This will make the application under
   `dist/agkyra` (and `dist/agkyra.app` under OSX).


## Copyright and license
Giorgos Korfiatis's avatar
Giorgos Korfiatis committed

Copyright (C) 2015 GRNET S.A.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.