cura-tools-devel November 2014

cura-tools-devel@lists.fedorahosted.org

2 participants
2 discussions

[cura-tools] master: Use intersphinx to resolve links to docs.openlmi.org. (00b524e)
by jsafrane＠fedoraproject.org 26 Nov '14

26 Nov '14

Repository : http://git.fedorahosted.org/cgit/cura-tools.git On branch : master >--------------------------------------------------------------- commit 00b524e681b4f0c9e4a75c7502ab63c582f99d64 Author: Jan Safranek <jsafrane(a)redhat.com> Date: Mon Nov 24 16:06:38 2014 +0100 Use intersphinx to resolve links to docs.openlmi.org. >--------------------------------------------------------------- doc/src/conf.py.skel | 7 +++++++ 1 files changed, 7 insertions(+), 0 deletions(-) diff --git a/doc/src/conf.py.skel b/doc/src/conf.py.skel index 4946cdf..bf8cb08 100644 --- a/doc/src/conf.py.skel +++ b/doc/src/conf.py.skel @@ -103,6 +103,13 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.viewcode'] +# Use local objects.inv for intersphinx, if available +local_inventory = None +path, filename = os.path.split(os.path.realpath(__file__)) +if os.path.isfile(path + "/objects.inv"): + local_inventory = path + "/objects.inv" +intersphinx_mapping = {'http://docs.openlmi.org/en/latest': local_inventory} + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']

1 0

[cura-tools] master: READMEs cleanup (4de9421)
by miminar＠fedoraproject.org 04 Nov '14

04 Nov '14

Repository : http://git.fedorahosted.org/cgit/cura-tools.git On branch : master >--------------------------------------------------------------- commit 4de94218135761cb3af126c6e938701388ed63d0 Author: Michal Minar <miminar(a)redhat.com> Date: Fri Oct 31 14:06:01 2014 +0100 READMEs cleanup Removed cli/README.md which is just metacommand related and contains redundat information (openlmi-scripts/README.md contains most of it and is up to date). Resolves: ticket #323 >--------------------------------------------------------------- README.md | 6 +- cli/Makefile | 2 +- cli/README.md | 133 --------------------------------------------------------- 3 files changed, 4 insertions(+), 137 deletions(-) diff --git a/README.md b/README.md index 693e5fe..f5148ca 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ bindings, standard APIs, and standard scripting interfaces. OpenLMI-tools ============= -OpenLMI-tools currently contains LMIShell, a (non)interactive command -interpreter for CIM objects access and LMI-Meta Command, which serves as a -command line interface to OpenLMI Providers, which utilizes LMIShell. +OpenLMI-tools currently contains *LMIShell*, a (non)interactive command +interpreter for CIM objects access and *LMI metacommand*, which serves as a +command line interface to OpenLMI Providers, which utilizes *LMIShell*. Dependencies ------------ diff --git a/cli/Makefile b/cli/Makefile index b15c149..33b582e 100644 --- a/cli/Makefile +++ b/cli/Makefile @@ -3,7 +3,7 @@ include ../Makefile.inc PYTHONPATH ?= $(HOME)/workspace/python_sandbox DEVELOPDIR ?= $(PYTHONPATH) DOCDIR := $(ROOTDIR)/doc -SOURCE ?= README.md +SOURCE ?= ../README.md TARGET ?= README.txt .PHONY: all readme sdist clean setup develop diff --git a/cli/README.md b/cli/README.md deleted file mode 100644 index 9e93cb8..0000000 --- a/cli/README.md +++ /dev/null @@ -1,133 +0,0 @@ -openlmi-scripts -=============== -Client-side python modules and command line utilities. - -It comprises of one binary called `lmi` and a common library. `lmi` -meta-command allows to run commands on a set of OpenLMI providers. These -commands can be installed separately in a modular way. - -`lmi` is a command line application allowing to run single command on a set -of hosts with just one statement from `shell` or it can run in an -interactive way. - -For more information please refer to online documentation on [pythonhosted][] -or build your own in `doc/` directory. - -Dependencies ------------- -Code base is written for `python 2.7`. -There are following python dependencies: - - * python-docopt - -### Uploading to PyPI -Since *PyPI* expects README file to be in a *reStructuredText* markup -language and the one present is written in *markdown*, it needs to be -converted to it. So please make sure you have `pandoc` installed before -running: - - $ python setup.py sdist upload - -Installation ------------- -Use standard `setuptools` script for installation: - - $ cd openlmi-scripts - $ python setup.py install --user - -This installs just the *lmi meta-command* and client-side library. To install -subcommands, you need to do the same procedure for each particular command -under `commands/` directory. - -Script eggs are also available on *PyPI*, install them with: - - $ pip install --user openlmi-scripts - $ # add any provider you want to interact with - $ pip install --user openlmi-scripts-service openlmi-scripts-software - -Usage ------ -To get a help and see available commands, run: - - $ lmi help - -To get a help for particular command, run: - - $ lmi help service - -To issue single command on a host, run: - - $ lmi --host ${hostname} service list - -To start the app in interactive mode: - - $ lmi --host ${hostname} - > service list --disabled - ... - > service start svnserve.service - ... - > quit - -Developing lmi scripts. ------------------------ - -This documents how to quickly develop lmi scripts without the need to -reinstall python eggs, when anything is changed. This presumes, that the -development process takes place in a git repotory checked out from [git][]. -It can be located anywhere on system. - -Before we start with setting up an environment, please double check, that you -don't have installed anything from openlmi-scripts in system path -(`/usr/lib/python2.7/site-packages/lmi/scripts` should not exist). And make -sure, that user path is also cleared: - - $ rm -rf $HOME/.local/lib/python2.7/site-packages/lmi* - $ rm -rf $HOME/.local/lib/python2.7/site-packages/openlmi* - -Install all dependencies: - - * python-docopt - * openlmi-python-base - * openlmi-tools - -Either via rpms or from respective git repositories. For openlmi-python-base -package contained in [providers-git][] repository the setup script is -located at `src/python/setup.py`. In future these will be available from PyPi. - -Let's setup an environment: - - 1. Create a workspace directory for current `$USER` (let's call it a `WSP`). - This is a place, where our eggs and binaries will be "installed". - It can be located anywhere, for example: - - $ WSP=~/.python_workspace - $ mkdir $WSP - - 2. Add workspace to your python path to make all modules installed there - importable (you can add this to your `~/.bashrc`): - - $ export PYTHONPATH=$WSP:$PYTHONPATH - - 3. Add workspace to your PATH, so the installed binaries can be run: - - $ export PATH=$WSP:$PATH - - 4. Now let's "install" to our workspace. First `cd` to checked out - openlmi-scripts repository. - 5. Install them and any commands you want -- possibly your own - - $ python setup.py develop --install-dir=$WSP - $ for cmd in service storage; do - > pushd commands/$cmd - > python setup.py develop --install-dir=$WSP - > popd - > done - -Now any change made to openlmi-scripts is immediately reflected in `lmi` -meta-command. - ------------------------------------------------------------------------------- -[git]: https://github.com/openlmi/openlmi-scripts "openlmi-scripts" -[providers-git]: https://fedorahosted.org/openlmi/browser/openlmi-providers "openlmi-providers" -[pythonhosted]: http://pythonhosted.org/openlmi-scripts/index.html "python hosted" -[PyPI]: https://pypi.python.org/pypi/openlmi-tools "PyPI"

1 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

cura-tools-devel November 2014