-
Notifications
You must be signed in to change notification settings - Fork 210
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit c95c0ae
Showing
20 changed files
with
1,968 additions
and
0 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,12 @@ | ||
*.pyc | ||
|
||
.installed.cfg | ||
bin | ||
develop-eggs | ||
eggs | ||
*.egg-info | ||
|
||
tmp | ||
build | ||
dist | ||
.coverage |
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,23 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2013 Jose Plana Mario | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
the Software, and to permit persons to whom the Software is furnished to do so, | ||
subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
|
||
|
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,2 @@ | ||
include README.rst | ||
include NEWS.txt |
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,9 @@ | ||
News | ||
==== | ||
|
||
0.1 | ||
--- | ||
|
||
*Release date: 18-Sep-2013* | ||
|
||
* Initial release |
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,125 @@ | ||
python-etcd documentation | ||
========================= | ||
|
||
A python client for Etcd https://github.com/coreos/etcd | ||
|
||
Installation | ||
------------ | ||
|
||
Pre-requirements | ||
~~~~~~~~~~~~~~~~ | ||
|
||
Install etcd | ||
|
||
From source | ||
~~~~~~~~~~~ | ||
|
||
.. code:: bash | ||
$ python setup.py install | ||
Usage | ||
----- | ||
|
||
Create a client object | ||
~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
.. code:: python | ||
import etcd | ||
client = etcd.Client() # this will create a client against etcd server running on localhost on port 4001 | ||
client = etcd.Client(port=4002) | ||
client = etcd.Client(host='127.0.0.1', port=4003) | ||
client = etcd.Client(host='127.0.0.1', port=4003, allow_redirect=False) # wont let you run sensitive commands on non-leader machines, default is true | ||
Set a key | ||
~~~~~~~~~ | ||
|
||
.. code:: python | ||
client.set('/nodes/n1', 1) | ||
# with ttl | ||
client.set('/nodes/n2', 2, ttl=4) # sets the ttl to 4 seconds | ||
Get a key | ||
~~~~~~~~~ | ||
|
||
.. code:: python | ||
client.get('/nodes/n2')['value'] | ||
Delete a key | ||
~~~~~~~~~~~~ | ||
|
||
.. code:: python | ||
client.delete('/nodes/n1') | ||
Test and set | ||
~~~~~~~~~~~~ | ||
|
||
.. code:: python | ||
client.test_and_set('/nodes/n2', 2, 4) # will set /nodes/n2 's value to 2 only if its previous value was 4 | ||
Watch a key | ||
~~~~~~~~~~~ | ||
|
||
.. code:: python | ||
client.watch('/nodes/n1') # will wait till the key is changed, and return once its changed | ||
List sub keys | ||
~~~~~~~~~~~~~ | ||
|
||
.. code:: python | ||
client.get('/nodes') | ||
Get machines in the cluster | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
.. code:: python | ||
client.machines | ||
Get leader of the cluster | ||
~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
.. code:: python | ||
client.leader | ||
Development setup | ||
----------------- | ||
|
||
To create a buildout, | ||
|
||
.. code:: bash | ||
$ python bootstrap.py | ||
$ bin/buildout | ||
to test you should have etcd available in your system path: | ||
|
||
.. code:: bash | ||
$ bin/test | ||
to generate documentation, | ||
|
||
.. code:: bash | ||
$ cd docs | ||
$ make | ||
Release HOWTO | ||
------------- | ||
|
||
To make a release | ||
|
||
1) Update release date/version in NEWS.txt and setup.py | ||
2) Run 'python setup.py sdist' | ||
3) Test the generated source distribution in dist/ | ||
4) Upload to PyPI: 'python setup.py sdist register upload' |
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,170 @@ | ||
############################################################################## | ||
# | ||
# Copyright (c) 2006 Zope Foundation and Contributors. | ||
# All Rights Reserved. | ||
# | ||
# This software is subject to the provisions of the Zope Public License, | ||
# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. | ||
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED | ||
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS | ||
# FOR A PARTICULAR PURPOSE. | ||
# | ||
############################################################################## | ||
"""Bootstrap a buildout-based project | ||
Simply run this script in a directory containing a buildout.cfg. | ||
The script accepts buildout command-line options, so you can | ||
use the -c option to specify an alternate configuration file. | ||
""" | ||
|
||
import os | ||
import shutil | ||
import sys | ||
import tempfile | ||
|
||
from optparse import OptionParser | ||
|
||
tmpeggs = tempfile.mkdtemp() | ||
|
||
usage = '''\ | ||
[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options] | ||
Bootstraps a buildout-based project. | ||
Simply run this script in a directory containing a buildout.cfg, using the | ||
Python that you want bin/buildout to use. | ||
Note that by using --find-links to point to local resources, you can keep | ||
this script from going over the network. | ||
''' | ||
|
||
parser = OptionParser(usage=usage) | ||
parser.add_option("-v", "--version", help="use a specific zc.buildout version") | ||
|
||
parser.add_option("-t", "--accept-buildout-test-releases", | ||
dest='accept_buildout_test_releases', | ||
action="store_true", default=False, | ||
help=("Normally, if you do not specify a --version, the " | ||
"bootstrap script and buildout gets the newest " | ||
"*final* versions of zc.buildout and its recipes and " | ||
"extensions for you. If you use this flag, " | ||
"bootstrap and buildout will get the newest releases " | ||
"even if they are alphas or betas.")) | ||
parser.add_option("-c", "--config-file", | ||
help=("Specify the path to the buildout configuration " | ||
"file to be used.")) | ||
parser.add_option("-f", "--find-links", | ||
help=("Specify a URL to search for buildout releases")) | ||
|
||
|
||
options, args = parser.parse_args() | ||
|
||
###################################################################### | ||
# load/install setuptools | ||
|
||
to_reload = False | ||
try: | ||
import pkg_resources | ||
import setuptools | ||
except ImportError: | ||
ez = {} | ||
|
||
try: | ||
from urllib.request import urlopen | ||
except ImportError: | ||
from urllib2 import urlopen | ||
|
||
# XXX use a more permanent ez_setup.py URL when available. | ||
exec(urlopen('https://bitbucket.org/pypa/setuptools/raw/0.7.2/ez_setup.py' | ||
).read(), ez) | ||
setup_args = dict(to_dir=tmpeggs, download_delay=0) | ||
ez['use_setuptools'](**setup_args) | ||
|
||
if to_reload: | ||
reload(pkg_resources) | ||
import pkg_resources | ||
# This does not (always?) update the default working set. We will | ||
# do it. | ||
for path in sys.path: | ||
if path not in pkg_resources.working_set.entries: | ||
pkg_resources.working_set.add_entry(path) | ||
|
||
###################################################################### | ||
# Install buildout | ||
|
||
ws = pkg_resources.working_set | ||
|
||
cmd = [sys.executable, '-c', | ||
'from setuptools.command.easy_install import main; main()', | ||
'-mZqNxd', tmpeggs] | ||
|
||
find_links = os.environ.get( | ||
'bootstrap-testing-find-links', | ||
options.find_links or | ||
('http://downloads.buildout.org/' | ||
if options.accept_buildout_test_releases else None) | ||
) | ||
if find_links: | ||
cmd.extend(['-f', find_links]) | ||
|
||
setuptools_path = ws.find( | ||
pkg_resources.Requirement.parse('setuptools')).location | ||
|
||
requirement = 'zc.buildout' | ||
version = options.version | ||
if version is None and not options.accept_buildout_test_releases: | ||
# Figure out the most recent final version of zc.buildout. | ||
import setuptools.package_index | ||
_final_parts = '*final-', '*final' | ||
|
||
def _final_version(parsed_version): | ||
for part in parsed_version: | ||
if (part[:1] == '*') and (part not in _final_parts): | ||
return False | ||
return True | ||
index = setuptools.package_index.PackageIndex( | ||
search_path=[setuptools_path]) | ||
if find_links: | ||
index.add_find_links((find_links,)) | ||
req = pkg_resources.Requirement.parse(requirement) | ||
if index.obtain(req) is not None: | ||
best = [] | ||
bestv = None | ||
for dist in index[req.project_name]: | ||
distv = dist.parsed_version | ||
if _final_version(distv): | ||
if bestv is None or distv > bestv: | ||
best = [dist] | ||
bestv = distv | ||
elif distv == bestv: | ||
best.append(dist) | ||
if best: | ||
best.sort() | ||
version = best[-1].version | ||
if version: | ||
requirement = '=='.join((requirement, version)) | ||
cmd.append(requirement) | ||
|
||
import subprocess | ||
if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0: | ||
raise Exception( | ||
"Failed to execute command:\n%s", | ||
repr(cmd)[1:-1]) | ||
|
||
###################################################################### | ||
# Import and run buildout | ||
|
||
ws.add_entry(tmpeggs) | ||
ws.require(requirement) | ||
import zc.buildout.buildout | ||
|
||
if not [a for a in args if '=' not in a]: | ||
args.append('bootstrap') | ||
|
||
# if -c was provided, we push it back into args for buildout' main function | ||
if options.config_file is not None: | ||
args[0:0] = ['-c', options.config_file] | ||
|
||
zc.buildout.buildout.main(args) | ||
shutil.rmtree(tmpeggs) |
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,22 @@ | ||
[buildout] | ||
parts = python | ||
sphinxbuilder | ||
test | ||
develop = . | ||
eggs = | ||
urllib3==1.7 | ||
|
||
[python] | ||
recipe = zc.recipe.egg | ||
interpreter = python | ||
eggs = ${buildout:eggs} | ||
|
||
[test] | ||
recipe = pbp.recipe.noserunner | ||
eggs = ${python:eggs} | ||
mock | ||
|
||
[sphinxbuilder] | ||
recipe = collective.recipe.sphinxbuilder | ||
source = ${buildout:directory}/docs-source | ||
build = ${buildout:directory}/docs |
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,8 @@ | ||
API Documentation | ||
========================= | ||
.. automodule:: etcd | ||
:members: | ||
.. autoclass:: Client | ||
:special-members: | ||
:members: | ||
:exclude-members: __weakref__ |
Oops, something went wrong.