You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ariatosca.apache.org by em...@apache.org on 2017/06/14 17:53:45 UTC
[4/5] incubator-ariatosca git commit: Fix Makefile and docs
Fix Makefile and docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/commit/306fc5d0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/tree/306fc5d0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/diff/306fc5d0
Branch: refs/heads/ARIA-54-prepare-aria-packaging
Commit: 306fc5d08da02b4ebc2c98ce1e6b33cb67143e7a
Parents: 98b27ef
Author: Tal Liron <ta...@gmail.com>
Authored: Tue Jun 13 16:05:19 2017 -0500
Committer: Tal Liron <ta...@gmail.com>
Committed: Wed Jun 14 11:50:25 2017 -0500
----------------------------------------------------------------------
MANIFEST.in | 12 ++---
Makefile | 40 ++++++++++-----
README.rst | 118 ++++++++++++++++++---------------------------
docs/conf.py | 3 +-
docs/requirements.txt | 4 +-
setup.cfg | 2 +
6 files changed, 88 insertions(+), 91 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/306fc5d0/MANIFEST.in
----------------------------------------------------------------------
diff --git a/MANIFEST.in b/MANIFEST.in
index dd16e28..13c9506 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,9 +1,9 @@
-include CHANGELOG.rst
-include CONTRIBUTING
include LICENSE
include NOTICE
-include README.rst
-include requirements.txt
+include CONTRIBUTING
include VERSION
-recursive-include docs *
-recursive-include examples *
\ No newline at end of file
+include CHANGELOG.rst
+include requirements.txt
+recursive-include docs/html *
+recursive-include examples *
+prune docs/html/.doctrees
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/306fc5d0/Makefile
----------------------------------------------------------------------
diff --git a/Makefile b/Makefile
index 3bafd3b..6022169 100644
--- a/Makefile
+++ b/Makefile
@@ -13,34 +13,50 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-EXTENSIONS=extensions
-DOCS=docs
-HTML=docs/html
+EXTENSIONS = ./extensions
+DIST = ./dist
+DOCS = ./docs
+HTML = ./docs/html
+EASY_INSTALL_PTH = $(VIRTUAL_ENV)/lib/python2.7/site-packages/easy-install.pth
-.PHONY: clean aria-requirements docs-requirements docs
.DEFAULT_GOAL = test
+.PHONY: clean install install-virtual requirements docs-requirements test-requirements docs test dist deploy
clean:
- rm -rf "$(HTML)" .tox .coverage*
+ rm -rf "$(DIST)" "$(HTML)" .tox .coverage*
-find . -type f -name '.coverage' -delete
-find . -type d -name '.coverage' -exec rm -rf {} \; 2>/dev/null
-find . -type d -name '*.egg-info' -exec rm -rf {} \; 2>/dev/null
install:
- pip install --upgrade .
+ pip install .
-requirements:
- pip install --upgrade --requirement requirements.txt
+install-virtual:
+ pip install --editable .
+
+ # "pip install --editable" will not add our extensions to the path, so we will patch the virtualenv
+ EXTENSIONS_PATH="$$(head -n 1 "$(EASY_INSTALL_PTH)")/extensions" && \
+ if ! grep -Fxq "$$EXTENSIONS_PATH" "$(EASY_INSTALL_PTH)"; then \
+ echo "$$EXTENSIONS_PATH" >> "$(EASY_INSTALL_PTH)"; \
+ fi
docs-requirements:
pip install --upgrade --requirement "$(DOCS)/requirements.txt"
test-requirements:
- pip install tox==2.5.0
+ pip install --upgrade tox>=2.7.0
-docs: docs-requirements requirements
+docs: docs-requirements
rm -rf "$(HTML)"
sphinx-build -b html "$(DOCS)" "$(HTML)"
-test: test-requirements requirements
- PYTHONPATH="$(EXTENSIONS):$(PYTHONPATH)" tox
+test: test-requirements
+ tox -e py27
+
+dist: docs
+ python ./setup.py sdist bdist_wheel
+
+deploy:
+ pip install --upgrade twine>=1.9.1
+ gpg --detach-sign -a "$(DIST)"/*
+ twine upload "$(DIST)"/*
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/306fc5d0/README.rst
----------------------------------------------------------------------
diff --git a/README.rst b/README.rst
index 91cdc3c..8af13a5 100644
--- a/README.rst
+++ b/README.rst
@@ -1,124 +1,103 @@
ARIA
====
-|Build Status| |Appveyor Build Status| |License| |PyPI release| |Python
-Versions| |Wheel| |Contributors| |Open Pull Requests| |Closed Pull
-Requests|
+|Build Status| |Appveyor Build Status| |License| |PyPI release| |Python Versions| |Wheel|
+|Contributors| |Open Pull Requests| |Closed Pull Requests|
+
What is ARIA?
-------------
`ARIA <http://ariatosca.incubator.apache.org/>`__ is a an open-source,
-`TOSCA <https://www.oasis-open.org/committees/tosca/>`__-based,
-lightweight library and CLI for orchestration and for consumption by
-projects building TOSCA-based solutions for resources and services
-orchestration.
+`TOSCA <https://www.oasis-open.org/committees/tosca/>`__-based, lightweight library and CLI for
+orchestration and for consumption by projects building TOSCA-based solutions for resources and
+services orchestration.
+
+ARIA can be utilized by any organization that wants to implement TOSCA-based orchestration in its
+solutions, whether a multi-cloud enterprise application, or an NFV or SDN solution for multiple
+virtual infrastructure managers.
-ARIA can be utilized by any organization that wants to implement
-TOSCA-based orchestration in its solutions, whether a multi-cloud
-enterprise application, or an NFV or SDN solution for multiple virtual
-infrastructure managers.
+With ARIA, you can utilize TOSCA's cloud portability out-of-the-box, to develop, test and run your
+applications, from template to deployment.
-With ARIA, you can utilize TOSCA's cloud portability out-of-the-box, to
-develop, test and run your applications, from template to deployment.
+ARIA is an incubation project under the `Apache Software Foundation <https://www.apache.org/>`__.
-ARIA is an incubation project under the `Apache Software
-Foundation <https://www.apache.org/>`__.
Installation
------------
ARIA is `available on PyPI <https://pypi.python.org/pypi/ariatosca>`__.
-To install ARIA directly from PyPI (using a ``wheel``), use:
-
-::
+To install ARIA directly from PyPI (using a ``wheel``), use::
pip install aria
To install ARIA from source, download the source tarball from
-`PyPI <https://pypi.python.org/pypi/ariatosca>`__, extract it, and then
-when inside the extracted directory, use:
-
-::
+`PyPI <https://pypi.python.org/pypi/ariatosca>`__, extract it, and then when inside the extracted
+directory, use::
pip install .
-The source package comes along with relevant examples, documentation,
-``requirements.txt`` (for installing specifically the frozen
-dependencies' versions with which ARIA was tested) and more.
+The source package comes along with relevant examples, documentation, ``requirements.txt`` (for
+installing specifically the frozen dependencies' versions with which ARIA was tested) and more.
-Note that for the ``pip install`` commands mentioned above, you must
-use a privileged user, or use virtualenv.
+Note that for the ``pip install`` commands mentioned above, you must use a privileged user, or use
+virtualenv.
-ARIA itself is in a ``wheel`` format compatible with all platforms. Some
-dependencies, however, might require compilation (based on a given
-platform), and therefore possibly some system dependencies are required
-as well.
+ARIA itself is in a ``wheel`` format compatible with all platforms. Some dependencies, however,
+might require compilation (based on a given platform), and therefore possibly some system
+dependencies are required as well.
-On Ubuntu or other Debian-based systems:
-
-::
+On Ubuntu or other Debian-based systems::
sudo apt install python-setuptools python-dev build-essential libssl-dev libffi-dev
-On Archlinux:
-
-::
+On Archlinux::
sudo pacman -S python-setuptools
ARIA requires Python 2.6/2.7. Python 3+ is currently not supported.
+
Getting Started
---------------
This section will describe how to run a simple "Hello World" example.
-First, provide ARIA with the ARIA "hello world" service-template and
-name it (e.g. ``my-service-template``):
-
-::
+First, provide ARIA with the ARIA "hello world" service-template and name it (e.g.
+``my-service-template``)::
aria service-templates store examples/hello-world/helloworld.yaml my-service-template
-Now create a service based on this service-template and name it (e.g.
-``my-service``):
-
-::
+Now create a service based on this service-template and name it (e.g. ``my-service``)::
aria services create my-service -t my-service-template
-Finally, start an ``install`` workflow execution on ``my-service`` like
-so:
-
-::
+Finally, start an ``install`` workflow execution on ``my-service`` like so::
aria executions start install -s my-service
-You should now have a simple web-server running on your local machine.
-You can try visiting http://localhost:9090 to view your deployed
-application.
-
-To uninstall and clean your environment, follow these steps:
+You should now have a simple web-server running on your local machine. You can try visiting
+``http://localhost:9090`` to view your deployed application.
-::
+To uninstall and clean your environment, follow these steps::
aria executions start uninstall -s my-service
aria services delete my-service
aria service-templates delete my-service-template
+
Contribution
------------
-You are welcome and encouraged to participate and contribute to the ARIA
-project.
+You are welcome and encouraged to participate and contribute to the ARIA project.
+
+Please see our guide to
+`Contributing to ARIA <https://cwiki.apache.org/confluence/display/ARIATOSCA/Contributing+to+ARIA>`__.
-Please see our guide to `Contributing to
-ARIA <https://cwiki.apache.org/confluence/display/ARIATOSCA/Contributing+to+ARIA>`__.
+Feel free to also provide feedback on the mailing lists (see `Resources <#user-content-resources>`__
+section).
-Feel free to also provide feedback on the mailing lists (see
-`Resources <#user-content-resources>`__ section).
Resources
---------
@@ -130,20 +109,19 @@ Resources
- Dev mailing list: dev@ariatosca.incubator.apache.org
- User mailing list: user@ariatosca.incubator.apache.org
-Subscribe by sending a mail to
-``<group>-subscribe@ariatosca.incubator.apache.org`` (e.g.
-``dev-subscribe@ariatosca.incubator.apache.org``). See information on
-how to subscribe to mailing lists
-`here <https://www.apache.org/foundation/mailinglists.html>`__.
+Subscribe by sending a mail to ``<group>-subscribe@ariatosca.incubator.apache.org`` (e.g.
+``dev-subscribe@ariatosca.incubator.apache.org``). See information on how to subscribe to mailing
+lists `here <https://www.apache.org/foundation/mailinglists.html>`__.
+
+For past correspondence, see the
+`dev mailing list archive <http://mail-archives.apache.org/mod_mbox/incubator-ariatosca-dev/>`__.
-For past correspondence, see the `dev mailing list
-archive <http://mail-archives.apache.org/mod_mbox/incubator-ariatosca-dev/>`__.
License
-------
-ARIA is licensed under the `Apache License
-2.0 <https://github.com/apache/incubator-ariatosca/blob/master/LICENSE>`__.
+ARIA is licensed under the
+`Apache License 2.0 <https://github.com/apache/incubator-ariatosca/blob/master/LICENSE>`__.
.. |Build Status| image:: https://img.shields.io/travis/apache/incubator-ariatosca/master.svg
:target: https://travis-ci.org/apache/incubator-ariatosca
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/306fc5d0/docs/conf.py
----------------------------------------------------------------------
diff --git a/docs/conf.py b/docs/conf.py
index cd25279..e557f02 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -36,7 +36,8 @@ import sys
sys.path.append(os.path.abspath('../aria'))
sys.path.append(os.path.abspath('../extensions'))
-execfile(os.path.join('../aria', 'VERSION.py'))
+with open('../VERSION') as f:
+ version = f.readline()
# -- General configuration ------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/306fc5d0/docs/requirements.txt
----------------------------------------------------------------------
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 72b28f1..df32b86 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -10,5 +10,5 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-Sphinx==1.5.3
-sphinx_rtd_theme==0.2.4
+Sphinx>=1.6.2
+sphinx_rtd_theme>=0.2.4
http://git-wip-us.apache.org/repos/asf/incubator-ariatosca/blob/306fc5d0/setup.cfg
----------------------------------------------------------------------
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..3c6e79c
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal=1