-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add initial documentation structure, with license authors, etc. (closes #1) * basic functionality to test client-server connection with ping Signed-off-by: Harri Hirvonsalo <harri.hirvonsalo@cern.ch>
- Loading branch information
Showing
24 changed files
with
819 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
# This file is part of REANA. | ||
# Copyright (C) 2017 CERN. | ||
# | ||
# REANA 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 2 of the License, or (at your option) any later | ||
# version. | ||
# | ||
# REANA 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 REANA; if not, see <http://www.gnu.org/licenses>. | ||
# | ||
# In applying this license, CERN does not waive the privileges and immunities | ||
# granted to it by virtue of its status as an Intergovernmental Organization or | ||
# submit itself to any jurisdiction. | ||
|
||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
env/ | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*,cover | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# Vagrant | ||
.vagrant | ||
|
||
# IntelliJ project files | ||
.idea | ||
*.iml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# This file is part of REANA. | ||
# Copyright (C) 2017 CERN. | ||
# | ||
# REANA 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 2 of the License, or (at your option) any later | ||
# version. | ||
# | ||
# REANA 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 Invenio; if not, see <http://www.gnu.org/licenses>. | ||
# | ||
# In applying this license, CERN does not waive the privileges and immunities | ||
# granted to it by virtue of its status as an Intergovernmental Organization or | ||
# submit itself to any jurisdiction. | ||
|
||
notifications: | ||
email: false | ||
|
||
sudo: true | ||
|
||
language: python | ||
|
||
cache: | ||
- pip | ||
|
||
python: | ||
- "3.5" | ||
|
||
before_install: | ||
- travis_retry pip install --upgrade pip setuptools py | ||
- travis_retry pip install twine wheel coveralls | ||
|
||
install: | ||
- travis_retry pip install -e .[all] | ||
|
||
script: | ||
- ./run-tests.sh | ||
|
||
after_success: | ||
- coveralls |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Authors | ||
======= | ||
|
||
* Diego Rodriguez <diego.rodriguez@cern.ch> | ||
* Harri Hirvonsalo <harri.hirvonsalo@cern.ch> | ||
* Tibor Simko <tibor.simko@cern.ch> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
Changes | ||
======= | ||
|
||
Version 0.0.1 (YYYY-MM-DD) | ||
-------------------------- | ||
|
||
- Initial public release. | ||
|
||
|
||
.. admonition:: CAVEAT LECTOR | ||
|
||
Please note that REANA Server is in an early developer preview alpha stage. | ||
No detailed changelog is provided yet. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
Contributing | ||
============ | ||
|
||
Issues | ||
------ | ||
|
||
Bug reports, feature requests, and other contributions are welcome. If you find | ||
a demonstrable problem that is caused by the REANA code, please: | ||
|
||
1. Search for `already reported problems | ||
<https://github.com/reanahub/reana-server/issues>`_. | ||
2. Check if the issue has been fixed or is still reproducible on the | ||
latest `master` branch. | ||
3. Create an issue, ideally with **a test case**. | ||
|
||
Pull requests | ||
------------- | ||
|
||
If you create a feature branch, you can run the tests to ensure that everything | ||
is operating correctly: | ||
|
||
.. code-block:: console | ||
$ ./run-tests.sh | ||
Each pull request should preserve or increase code coverage. | ||
|
||
Kanban | ||
------ | ||
|
||
We are using Kanban technique for keeping track of ongoing tasks. Please see our | ||
`Kanban board <https://waffle.io/reanahub/reana>`_ and look for issues that are | ||
labelled as "ready for work". |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# This file is part of REANA. | ||
# Copyright (C) 2017 CERN. | ||
# | ||
# REANA 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 2 of the License, or (at your option) any later | ||
# version. | ||
# | ||
# REANA 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 REANA; if not, see <http://www.gnu.org/licenses>. | ||
# | ||
# In applying this license, CERN does not waive the privileges and immunities | ||
# granted to it by virtue of its status as an Intergovernmental Organization or | ||
# submit itself to any jurisdiction. | ||
|
||
include COPYING | ||
include *.rst | ||
include *.sh | ||
include pytest.ini | ||
prune docs/_build | ||
recursive-include docs *.py | ||
recursive-include docs *.png | ||
recursive-include docs *.rst | ||
recursive-include tests *.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,24 @@ | ||
============== | ||
REANA server | ||
============== | ||
====================== | ||
REANA Server | ||
====================== | ||
|
||
This repository provides the REANA server that takes and performs REST API calls | ||
issued by REANA client. | ||
.. image:: https://img.shields.io/travis/reanahub/reana-server.svg | ||
:target: https://travis-ci.org/reanahub/reana-server | ||
|
||
.. image:: https://img.shields.io/coveralls/reanahub/reana-server.svg | ||
:target: https://coveralls.io/r/reanahub/reana-server | ||
|
||
.. image:: https://readthedocs.org/projects/docs/badge/?version=latest | ||
:target: https://reana-server.readthedocs.io/en/latest/?badge=latest | ||
|
||
.. image:: https://badge.waffle.io/reanahub/reana.svg?label=Status%3A%20ready%20for%20work&title=Issues%20ready%20for%20work | ||
:target: https://waffle.io/reanahub/reana | ||
|
||
.. image:: https://badges.gitter.im/Join%20Chat.svg | ||
:target: https://gitter.im/reanahub/reana?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge | ||
|
||
.. image:: https://img.shields.io/github/license/reanahub/reana-server.svg | ||
:target: https://github.com/reanahub/reana-server/blob/master/COPYING | ||
|
||
This repository provides the REANA server that takes and performs REST API calls issued by REANA client. | ||
Reana Server is part of the REANA system. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../AUTHORS.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../CHANGES.rst |
Oops, something went wrong.