python-geoclue/ 0000777 0001750 0001750 00000000000 11245335113 013606 5 ustar pcabido pcabido python-geoclue/Geoclue/ 0000777 0001750 0001750 00000000000 11245335107 015174 5 ustar pcabido pcabido python-geoclue/tests/ 0000777 0001750 0001750 00000000000 11241354452 014753 5 ustar pcabido pcabido python-geoclue/docs/ 0000755 0001750 0001750 00000000000 11245331631 014533 5 ustar pcabido pcabido python-geoclue/setup.py 0000777 0001750 0001750 00000002254 11244111612 015321 0 ustar pcabido pcabido #! /usr/bin/env python
import sys,os
sys.path.insert(0,os.getcwd())
import Geoclue
from distutils.core import setup
VERSION = '0.1.0'
setup(name='python-geoclue',
version=VERSION,
author='Paulo Cabido',
author_email='paulo.cabido@gmail.com',
url='http://were.it.is.hosted',
# download_url='http://were.it.is.hosted/files/python-geoclue-%s.tar.gz' % VERSION,
description='Geoclue python module',
license='GLP3',
long_description="""
Python-Geoclue is nice API interface for Geoclue.
Almost all Geoclue methods are available.
It uses the D-Bus Geoclue API in order to facilitate Geoclue's use.
""",
packages=['Geoclue'],
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'License :: OSI Approved :: GNU General Public License (GPL)',
'Operating System :: OS Independent',
'Programming Language :: Python',
# 'Programming Language :: Python :: 2.6',
'Topic :: Software Development :: Libraries',
'Topic :: Software Development :: Libraries :: Python Modules'
],
) python-geoclue/README 0000777 0001750 0001750 00000000000 11224351704 014460 0 ustar pcabido pcabido python-geoclue/LICENSE 0000777 0001750 0001750 00000104513 11224351704 014623 0 ustar pcabido pcabido GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
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 .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
python-geoclue/AUTHORS 0000777 0001750 0001750 00000000045 11224351704 014661 0 ustar pcabido pcabido Paulo Cabido python-geoclue/Geoclue/__init__.py 0000777 0001750 0001750 00000001365 11227053674 017323 0 ustar pcabido pcabido # -*- coding: utf-8 -*-
# Copyright (c) 2009 - Paulo Cabido
#
# 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 .
from Base import *
VERSION = "0.1"
python-geoclue/Geoclue/Base.py 0000777 0001750 0001750 00000042045 11244010341 016415 0 ustar pcabido pcabido # -*- coding: utf-8 -*-
# Copyright (c) 2009 - Paulo Cabido
#
# 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 .
import os
import sys
import math
import dbus
from dbus.mainloop.glib import DBusGMainLoop
import gobject
import geoclue
from Signal import Signal
DBusGMainLoop(set_as_default=True)
class DiscoverLocation:
""" Discovers the location form the best available provider
L{DiscoverLocation} is a object that provides a nice API interface
for Geoclue.
"""
def __init__(self, providers_path="/usr/share/geoclue-providers"):
"""Construct a L{DiscoverLocation} object.
@param providers_path: The path to the providers. The default
path to the providers is /usr/share/geoclue-providers.
"""
self.bus = dbus.SessionBus()
self.signal = Signal()
# stores the location info
self.location_info = {}
# Insipered by Pierre-Luc Beaudoin - geoclue_properties.py
# TODO: add an exception to this part of the code in case of the wrong
# or nonexisting dir
self.providers = []
dir = os.listdir(providers_path)
for filename in dir:
(name, ext) = os.path.splitext(filename)
if ext == ".provider":
complete = os.path.join(providers_path, filename)
provider = geoclue.GeoclueProvider (complete)
self.providers.append([provider,
provider.name,
provider.interfaces & geoclue.INTERFACE_ADDRESS,
provider.interfaces & geoclue.INTERFACE_POSITION,
provider.interfaces & geoclue.INTERFACE_GEOCODE,
provider.interfaces & geoclue.INTERFACE_REVERSE_GEOCODE,
provider.service,
provider.path
])
def init(self, accuracy=geoclue.ACCURACY_LEVEL_COUNTRY, resource=geoclue.RESOURCE_NETWORK):
"""Initializes Geoclue.
@param accuracy: The desired accuracy.
@param resource: The resource to be used.
"""
self.accuracy = accuracy
self.resource = resource
try:
self.master = self.bus.get_object(geoclue.MASTER_IFACE, geoclue.MASTER_PATH)
self.client = self.bus.get_object(geoclue.MASTER_IFACE, self.master.Create())
# connects to detect changes on the address and position providers
self.client.connect_to_signal("AddressProviderChanged", self.on_address_provider_changed)
self.client.connect_to_signal("PositionProviderChanged", self.on_position_provider_changed)
self.address = dbus.Interface(self.client, dbus_interface=geoclue.ADDRESS_IFACE)
self.address.connect_to_signal("AddressChanged", self.on_address_changed)
self.client.AddressStart()
self.position = dbus.Interface(self.client, dbus_interface=geoclue.POSITION_IFACE)
self.position.connect_to_signal("PositionChanged", self.on_position_changed)
self.client.PositionStart()
self.client.SetRequirements(self.accuracy, 0, True, self.resource)
try:
self.on_address_changed(*self.address.GetAddress())
except Exception, e:
return False
try:
self.on_position_changed(*self.position.GetPosition())
except Exception, e:
return False
return True
except Exception, e:
print "Error: %s" % e
return False
def provider_status(self, provider):
"""Checks a provider's status.
@param provider: A provider instance.
@return: The status.
"""
obj = dbus.Interface(provider.get_proxy(), dbus_interface=geoclue.GEOCLUE_IFACE)
status = obj.GetStatus()
if status == geoclue.STATUS_ERROR:
return "error"
elif status == geoclue.STATUS_UNAVAILABLE:
return "unavailable"
elif status == geoclue.STATUS_ACQUIRING:
return "acquiring"
elif status == geoclue.STATUS_AVAILABLE:
return "available"
else:
return "error"
def provider_info(self, provider):
"""Returns the provider's Info.
@return: A dictionary with the provider's name and descripiton.
"""
obj = dbus.Interface(provider.get_proxy(), dbus_interface=geoclue.GEOCLUE_IFACE)
info = obj.GetProviderInfo()
tmp = {}
tmp['name'] = str(info[0])
tmp['description'] = str(info[1])
return tmp
def set_requirements(self, accuracy, time, require_updates, resource):
"""Set the client requirements.
@param accuracy: The required minimum accuracy.
@param time: The minimum time between update signals.
@param require_updates: C{True} if updates are required or C{False} if updates
are not required.
@param resource: The resources that are allowed to be used.
"""
self.accuracy = accuracy
self.resource = resource
self.client.SetRequirements(accuracy, time, require_updates, allowed_resources)
# provider changed methods, not really being used but it's useful to have
# them here just in case
def on_address_provider_changed(self, name, description, service, path):
#print "Address provider changed"
pass
def on_position_provider_changed(self, name, description, service, path):
#print "Position provider changed"
pass
def update_location_address(self, address):
"""Updates the the location's address with the given C{address}.
@address: The new address.
"""
if address.has_key('street'):
self.location_info['street'] = address['street']
# TODO: postalcode ?
if address.has_key('area'):
self.locatio_infon['area'] = address['area']
if address.has_key('locality'):
self.location_info['locality'] = address['locality']
if address.has_key('country'):
self.location_info['country'] = address['country']
if address.has_key('region'):
self.location_info['region'] = address['region']
if address.has_key('countrycode'):
self.location_info['countrycode'] = address['countrycode']
def on_address_changed(self, timestamp, address, accuracy):
"""When the address changes the location info dictionary is updated.
@param timestamp: The timestamp.
@param address: The new address.
@accuracy: The accuracy.
"""
self.location_info['address_timestamp'] = timestamp
self.update_location_address(address)
self.signal()
def on_position_changed(self, fields, timestamp, latitude, longitude, altitude, accuracy):
"""When the position changes the location info dictionary is updated.
@param fields: The fields.
@param timestamp: The timestamp.
@param latitude: The new latitude.
@param longitude: The new longitude.
@param altitude: The new altitude.
@param accuracy: The accuracy.
"""
#print accuracy # I used this print to check the accuracy format
self.location_info['position_timestamp'] = timestamp
self.location_info['latitude'] = latitude
self.location_info['longitude'] = longitude
self.location_info['altitude'] = altitude
self.signal()
# returns the current values for location and position
def get_location_info(self):
"""Returns the location info dictionary.
@return: The location info dictionary.
"""
return self.location_info
def get_available_providers(self):
"""Returns the available providers.
@return: A list of dictionarys,
[PROVIDER, ADDRESS, POSITION, GEOCODING, REVERSE GEOCODING],
with the name and True of False for supporting each of them
"""
current_providers = []
for provider in self.providers:
tmp = {}
tmp['name'] = provider[1]
if provider[2] != 0:
tmp['address'] = True
else:
tmp['address'] = False
if provider[3] != 0:
tmp['position'] = True
else:
tmp['position'] = False
if provider[4] != 0:
tmp['geocoding'] = True
else:
tmp['geocoding'] = False
if provider[5] != 0:
tmp['revgeocoding'] = True
else:
tmp['revgeocoding'] = False
tmp['object'] = provider[0]
tmp['service'] = provider[6]
tmp['path'] = provider[7]
current_providers.append(tmp)
return current_providers
def set_position_provider(self, provider_name):
"""Set the position provider to a given C{provider_name} (if exists).
@param provider_name: The provider's name
@return: C{True} if the provider exists or C{False} if a provider
does not exist.
"""
provider_exists = False
for provider in self.providers:
if provider[1].lower() == provider_name.lower() and provider[3] != 0:
current_provider = provider
provider_exists = True
break
if not provider_exists:
return False
try:
tmp_provider = current_provider[0].get_proxy()
self.position = dbus.Interface(tmp_provider, dbus_interface=geoclue.POSITION_IFACE)
except Exception, e:
print "D-Bus error: %s" % e
return False
try:
self.on_position_changed(*self.position.GetPosition())
except Exception, e:
print e
return True
def validate_address(self, address):
"""Receives the address and validates/corrects it.
@param address: The address dictionary.
@return: The address (with possible corrections).
"""
tmp_address = {}
if address.has_key('street'):
tmp_address['street'] = address['street']
else:
tmp_address['street'] = ""
# TODO: postalcode ?
if address.has_key('area'):
tmp_address['area'] = address['area']
else:
tmp_address['area'] = ""
if address.has_key('locality'):
tmp_address['locality'] = address['locality']
else:
tmp_address['locality'] = ""
if address.has_key('country'):
tmp_address['country'] = address['country']
else:
tmp_address['country'] = ""
if address.has_key('region'):
tmp_address['region'] = address['region']
else:
tmp_address['region'] = ""
if address.has_key('countrycode'):
tmp_address['countrycode'] = address['countrycode']
else:
tmp_address['countrycode'] = ""
return tmp_address
# TODO: add "valid-for" to continue to use the given provider
def set_address_provider(self, provider_name, address=None):
"""Set the address provider
@param provider_name: the provider's name
@param address: the new address (for Manual and Localnet providers)
@returns: C{True} if the provider exists or C{False} if a provider
does not exist.
"""
provider_exists = False
for provider in self.providers:
if provider[1].lower() == provider_name.lower() and provider[2] != 0:
current_provider = provider
provider_exists = True
break
if not provider_exists:
return False
try:
if (provider_name.lower() == "manual" or provider_name.lower() == "localnet") and address != None:
tmp_provider = current_provider[0].get_proxy()
tmp_provider.SetAddress(0, self.validate_address(address))
self.address = dbus.Interface(tmp_provider, dbus_interface=geoclue.ADDRESS_IFACE)
elif (provider_name.lower() == "manual" or provider_name.lower() == "localnet") and address == None:
return False
else:
self.address = dbus.Interface(current_provider[0].get_proxy(), dbus_interface=geoclue.ADDRESS_IFACE)
except Exception, e:
print "D-Bus error: %s" % e
return False
try:
self.on_address_changed(*self.address.GetAddress())
except Exception, e:
print e
return True
def get_position_provider(self):
"""Returns the name of the current position provider.
@return: The name of the current position provider.
"""
return self.client.GetPositionProvider()[0]
def get_address_provider(self):
"""Returns the name of the current address provider.
@return: The name of the current address provider.
"""
return self.client.GetAddressProvider()[0]
def compare_position(self, latitude, longitude, proximity_factor=None):
"""Compare the current position to a given position.
Note: ploum's contribution
@param latitude: latitude of the position
@param longitude: longitude of the position
@param proximity_factor: the near by proximity factor. ie, 0.5 is 500 meters
"""
if proximity_factor == None:
# 500 meters
dis_max = 0.5
else:
dis_max = proximity_factor
# todo_later : (calibration must be done with a well known distance )
#This method assumes a spheroidal model for the earth with
#an average radius of 6364.963 km.
#The formula is estimated to have an accuracy of about 200 metres
#over 50 km, but may deteriorate with longer distances.
#source : http://www.ga.gov.au/geodesy/datums/distance.jsp
dl = self.location_info['latitude'] - latitude
dg = self.location_info['longitude'] - longitude
term1 = 111.08956 * (dl + 0.000001)
term2 = math.cos(self.location_info['latitude'] + (dl/2))
term3 = (dg + 0.000001) / (dl + 0.000001)
d = term1 / math.cos(math.atan(term2 * term3))
result = math.fabs(d) < dis_max
return result
def reverse_position(self, latitude, longitude, accuracy):
"""Returns an address that corresponds to a given position.
@param latitude: The position's latitude.
@param longitude: The position's longitude.
@param accuracy: The accuracy.
@return: An address.
"""
provider_exists = False
for provider in self.providers:
if provider[1].lower() == "Geonames Provider".lower():
current_provider = provider
provider_exists = True
break
if not provider_exists:
return None
try:
revgeocoder = dbus.Interface(current_provider[0].get_proxy(), geoclue.REVERSE_IFACE)
revaddress = revgeocoder.PositionToAddress(float(latitude), float(longitude), (accuracy, 0, 0))
#add the values to the address of the location variable
tmp_address = {}
for key, item in revaddress[0].items():
tmp_address[unicode(key)] = unicode(item)
return self.validate_address(tmp_address)
except Exception, e:
print "D-Bus error: %s" % e
return None
def connect(self, func):
"""Connects a given function to the signal.
The signal action if any change to the info location dictionary.
@param func: The function to connect to the signal.
"""
self.signal.connect(func)
def disconnect(self, func):
"""Disconnects a given function from the signal.
@param func: The function to disconnect from the signal.
"""
self.signal.disconnect(func)
python-geoclue/Geoclue/Signal.py 0000777 0001750 0001750 00000004425 11227045424 016773 0 ustar pcabido pcabido # -*- coding: utf-8 -*-
# Copyright (c) 2009 - Paulo Cabido
#
# 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 .
import random
class Signal:
class Slot:
def __init__(self, func):
self.__func = func
def __call__(self, accum, *args, **kwargs):
result = self.__func(*args, **kwargs)
return accum(result)
class Accumulator:
def __call__(self, *args, **kwargs):
return True
def finalize(self):
return None
def __init__(self):
self.__slots = []
def create_accumulator(self):
return self.Accumulator()
# execute the slots
def __call__(self, *args, **kwargs):
accum = self.create_accumulator()
for conn in xrange(len(self.__slots)):
if not self.__slots[conn][1](accum, *args, **kwargs):
break
return accum.finalize()
def find(self, conn):
for i in xrange(len(self.__slots)):
if self.__slots[i][0] == conn:
return i
return -1
# create the connection name
def new_connection(self):
value = 0
while self.find(value) >= 0:
value = random.randint(1, 100000000)
return value
def connect(self, func):
conn = self.new_connection()
self.__slots.append([conn, Signal.Slot(func)])
return conn
# disconnect a slot
def disconnect(self, conn):
result = self.Find(conn)
if result >= 0:
del self.__slots[result]
# disconnect all slots
def disconnect_all(self):
self.__slots = []
python-geoclue/Geoclue/geoclue.py 0000777 0001750 0001750 00000006626 11241370056 017204 0 ustar pcabido pcabido # -*- coding: utf-8 -*-
# This file is based on the original geoclue.py by Pierre-Luc Beaudoin
#
# Copyright (c) 2009 - Paulo Cabido
#
# 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 .
import ConfigParser
import dbus
POSITION_FIELDS_NONE = 0
POSITION_FIELDS_LATITUDE = 1 << 0
POSITION_FIELDS_LONGITUDE = 1 << 1
POSITION_FIELDS_ALTITUDE = 1 << 2
ADDRESS_FIELD_STREET = "street"
ADDRESS_FIELD_AREA = "area"
ADDRESS_FIELD_LOCALITY = "locality"
ADDRESS_FIELD_REGION = "region"
ADDRESS_FIELD_COUNTRY = "country"
RESOURCE_NONE = 0
RESOURCE_NETWORK = 1 << 0
RESOURCE_CELL = 1 << 1
RESOURCE_GPS = 1 << 2
RESOURCE_ALL = (1 << 10) - 1
ACCURACY_LEVEL_NONE = 0
ACCURACY_LEVEL_COUNTRY = 1
ACCURACY_LEVEL_REGION = 2
ACCURACY_LEVEL_LOCALITY = 3
ACCURACY_LEVEL_POSTALCODE = 4
ACCURACY_LEVEL_STREET = 5
ACCURACY_LEVEL_DETAILED = 6
INTERFACE_NONE = 0
INTERFACE_ADDRESS = 1 << 0
INTERFACE_POSITION = 1 << 1
INTERFACE_GEOCODE = 1 << 2
INTERFACE_REVERSE_GEOCODE = 1 << 3
STATUS_ERROR = 0
STATUS_UNAVAILABLE = 1
STATUS_ACQUIRING = 2
STATUS_AVAILABLE = 3
### PROVIDERS - Added, pcabido
MASTER_IFACE = "org.freedesktop.Geoclue.Master"
MASTER_PATH = "/org/freedesktop/Geoclue/Master"
ADDRESS_IFACE = "org.freedesktop.Geoclue.Address"
ADDRESS_PATH = "/org/freedesktop/Geoclue/Address"
POSITION_IFACE = "org.freedesktop.Geoclue.Position"
POSITION_PATH = "/org/freedesktop/Geoclue/Position"
GEOCLUE_IFACE = "org.freedesktop.Geoclue"
GEOCLUE_PATH = "/org/freedesktop/Geoclue"
GEONAMES_IFACE = "org.freedesktop.Geoclue.Providers.Geonames"
GEONAMES_PATH = "/org/freedesktop/Geoclue/Providers/Geonames"
REVERSE_IFACE = "org.freedesktop.Geoclue.ReverseGeocode"
REVERSE_PATH = "/org/freedesktop/Geoclue/ReverseGeocode"
###
class GeoclueProvider():
pass
def __init__ (self, filename):
'''
Takes the path to a .provider file
'''
file = ConfigParser.RawConfigParser()
file.read(filename)
self.name = file.get('Geoclue Provider', 'Name')
self.path = file.get('Geoclue Provider', 'Path')
self.service = file.get('Geoclue Provider', 'Service')
interfaces = file.get('Geoclue Provider', 'Interfaces').split(";")
self.interfaces = INTERFACE_NONE
for interface in interfaces:
if interface == "org.freedesktop.Geoclue.Address":
self.interfaces += INTERFACE_ADDRESS
elif interface == "org.freedesktop.Geoclue.Position":
self.interfaces += INTERFACE_POSITION
elif interface == "org.freedesktop.Geoclue.Geocode":
self.interfaces += INTERFACE_GEOCODE
elif interface == "org.freedesktop.Geoclue.ReverseGeocode":
self.interfaces += INTERFACE_REVERSE_GEOCODE
def get_proxy (self):
self.bus = dbus.SessionBus()
return self.bus.get_object(self.service, self.path)
python-geoclue/tests/test.py 0000777 0001750 0001750 00000005041 11227055047 016311 0 ustar pcabido pcabido #!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2009 - Paulo Cabido
#
# 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 .
import sys ; sys.path.insert(0, '..')
import Geoclue as geoclue
def location_change():
print "Location info changed:"
print geolocation.get_location_info()
print "\n"
geolocation = geoclue.DiscoverLocation()
geolocation.connect(location_change)
geolocation.init()
location = geolocation.get_location_info()
print "Location: "
print location
print "\n"
providers = geolocation.get_available_providers()
#print providers
# when a GPS is available, this will pass to the GPS provider
# this will change the master's default provider acording to the requirements
#geolocation.set_requirements(6, 0, True, (1 << 2))
# this will get the current position via GPS but it will continue to use
# the default master provider
geolocation.set_position_provider("Gpsd")
# as you can see, the signal function displays the GPS position :-)
address = {}
address['street'] = "Rua portuguesa num da porta"
address['area'] = "Centro Historico"
address['locality'] = "Evora"
address['region'] = "Evora"
address['country'] = "Portugal"
address['countrycode'] = "PT"
# Localnet provider also uses the address
geolocation.set_address_provider("Manual", address)
current_address_provider = geolocation.get_address_provider()
print "Current address provider: %s" % current_address_provider
current_position_provider = geolocation.get_position_provider()
print "Current position provider: %s" % current_position_provider
print "Reverse address for coordinates lat: 38.5833333 and lon: -7.8333333"
revgeocoder = geolocation.reverse_position(38.5833333, -7.833333, 3)
print revgeocoder
print "\n"
# Compare the current position to a given position with a proximity factor of 500m
# It will return true or false
#print "Compare a position to the current position:"
#print "Position to compare, lat: %s lon: %s"
#geolocation.compare_position(LAT, LON, 0.5)
python-geoclue/docs/index.html 0000644 0001750 0001750 00000001115 11245331631 016526 0 ustar pcabido pcabido
API Documentation
python-geoclue/docs/api-objects.txt 0000644 0001750 0001750 00000017063 11245331631 017503 0 ustar pcabido pcabido Geoclue Geoclue-module.html
Geoclue.VERSION Geoclue-module.html#VERSION
Geoclue.__package__ Geoclue-module.html#__package__
Geoclue.DBusGMainLoop Geoclue.Base-module.html#DBusGMainLoop
Geoclue.Base Geoclue.Base-module.html
Geoclue.Base.__package__ Geoclue.Base-module.html#__package__
Geoclue.Signal' Geoclue.Signal%27-module.html
Geoclue.Signal'.__package__ Geoclue.Signal%27-module.html#__package__
Geoclue.geoclue Geoclue.geoclue-module.html
Geoclue.geoclue.GEOCLUE_IFACE Geoclue.geoclue-module.html#GEOCLUE_IFACE
Geoclue.geoclue.POSITION_FIELDS_NONE Geoclue.geoclue-module.html#POSITION_FIELDS_NONE
Geoclue.geoclue.INTERFACE_POSITION Geoclue.geoclue-module.html#INTERFACE_POSITION
Geoclue.geoclue.GEONAMES_PATH Geoclue.geoclue-module.html#GEONAMES_PATH
Geoclue.geoclue.ACCURACY_LEVEL_COUNTRY Geoclue.geoclue-module.html#ACCURACY_LEVEL_COUNTRY
Geoclue.geoclue.ADDRESS_FIELD_AREA Geoclue.geoclue-module.html#ADDRESS_FIELD_AREA
Geoclue.geoclue.ACCURACY_LEVEL_DETAILED Geoclue.geoclue-module.html#ACCURACY_LEVEL_DETAILED
Geoclue.geoclue.GEOCLUE_PATH Geoclue.geoclue-module.html#GEOCLUE_PATH
Geoclue.geoclue.MASTER_IFACE Geoclue.geoclue-module.html#MASTER_IFACE
Geoclue.geoclue.ADDRESS_FIELD_LOCALITY Geoclue.geoclue-module.html#ADDRESS_FIELD_LOCALITY
Geoclue.geoclue.MASTER_PATH Geoclue.geoclue-module.html#MASTER_PATH
Geoclue.geoclue.POSITION_FIELDS_LATITUDE Geoclue.geoclue-module.html#POSITION_FIELDS_LATITUDE
Geoclue.geoclue.ADDRESS_PATH Geoclue.geoclue-module.html#ADDRESS_PATH
Geoclue.geoclue.REVERSE_PATH Geoclue.geoclue-module.html#REVERSE_PATH
Geoclue.geoclue.POSITION_FIELDS_LONGITUDE Geoclue.geoclue-module.html#POSITION_FIELDS_LONGITUDE
Geoclue.geoclue.INTERFACE_ADDRESS Geoclue.geoclue-module.html#INTERFACE_ADDRESS
Geoclue.geoclue.INTERFACE_REVERSE_GEOCODE Geoclue.geoclue-module.html#INTERFACE_REVERSE_GEOCODE
Geoclue.geoclue.__package__ Geoclue.geoclue-module.html#__package__
Geoclue.geoclue.POSITION_FIELDS_ALTITUDE Geoclue.geoclue-module.html#POSITION_FIELDS_ALTITUDE
Geoclue.geoclue.RESOURCE_ALL Geoclue.geoclue-module.html#RESOURCE_ALL
Geoclue.geoclue.ADDRESS_FIELD_COUNTRY Geoclue.geoclue-module.html#ADDRESS_FIELD_COUNTRY
Geoclue.geoclue.STATUS_ACQUIRING Geoclue.geoclue-module.html#STATUS_ACQUIRING
Geoclue.geoclue.ACCURACY_LEVEL_LOCALITY Geoclue.geoclue-module.html#ACCURACY_LEVEL_LOCALITY
Geoclue.geoclue.ACCURACY_LEVEL_POSTALCODE Geoclue.geoclue-module.html#ACCURACY_LEVEL_POSTALCODE
Geoclue.geoclue.STATUS_AVAILABLE Geoclue.geoclue-module.html#STATUS_AVAILABLE
Geoclue.geoclue.REVERSE_IFACE Geoclue.geoclue-module.html#REVERSE_IFACE
Geoclue.geoclue.POSITION_PATH Geoclue.geoclue-module.html#POSITION_PATH
Geoclue.geoclue.GEONAMES_IFACE Geoclue.geoclue-module.html#GEONAMES_IFACE
Geoclue.geoclue.STATUS_UNAVAILABLE Geoclue.geoclue-module.html#STATUS_UNAVAILABLE
Geoclue.geoclue.ADDRESS_FIELD_REGION Geoclue.geoclue-module.html#ADDRESS_FIELD_REGION
Geoclue.geoclue.RESOURCE_NETWORK Geoclue.geoclue-module.html#RESOURCE_NETWORK
Geoclue.geoclue.INTERFACE_NONE Geoclue.geoclue-module.html#INTERFACE_NONE
Geoclue.geoclue.ACCURACY_LEVEL_REGION Geoclue.geoclue-module.html#ACCURACY_LEVEL_REGION
Geoclue.geoclue.RESOURCE_NONE Geoclue.geoclue-module.html#RESOURCE_NONE
Geoclue.geoclue.ADDRESS_FIELD_STREET Geoclue.geoclue-module.html#ADDRESS_FIELD_STREET
Geoclue.geoclue.ACCURACY_LEVEL_NONE Geoclue.geoclue-module.html#ACCURACY_LEVEL_NONE
Geoclue.geoclue.INTERFACE_GEOCODE Geoclue.geoclue-module.html#INTERFACE_GEOCODE
Geoclue.geoclue.STATUS_ERROR Geoclue.geoclue-module.html#STATUS_ERROR
Geoclue.geoclue.ADDRESS_IFACE Geoclue.geoclue-module.html#ADDRESS_IFACE
Geoclue.geoclue.ACCURACY_LEVEL_STREET Geoclue.geoclue-module.html#ACCURACY_LEVEL_STREET
Geoclue.geoclue.RESOURCE_GPS Geoclue.geoclue-module.html#RESOURCE_GPS
Geoclue.geoclue.POSITION_IFACE Geoclue.geoclue-module.html#POSITION_IFACE
Geoclue.geoclue.RESOURCE_CELL Geoclue.geoclue-module.html#RESOURCE_CELL
Geoclue.Base.DiscoverLocation Geoclue.Base.DiscoverLocation-class.html
Geoclue.Base.DiscoverLocation.get_location_info Geoclue.Base.DiscoverLocation-class.html#get_location_info
Geoclue.Base.DiscoverLocation.get_address_provider Geoclue.Base.DiscoverLocation-class.html#get_address_provider
Geoclue.Base.DiscoverLocation.disconnect Geoclue.Base.DiscoverLocation-class.html#disconnect
Geoclue.Base.DiscoverLocation.on_position_changed Geoclue.Base.DiscoverLocation-class.html#on_position_changed
Geoclue.Base.DiscoverLocation.set_address_provider Geoclue.Base.DiscoverLocation-class.html#set_address_provider
Geoclue.Base.DiscoverLocation.on_address_provider_changed Geoclue.Base.DiscoverLocation-class.html#on_address_provider_changed
Geoclue.Base.DiscoverLocation.on_position_provider_changed Geoclue.Base.DiscoverLocation-class.html#on_position_provider_changed
Geoclue.Base.DiscoverLocation.provider_status Geoclue.Base.DiscoverLocation-class.html#provider_status
Geoclue.Base.DiscoverLocation.on_address_changed Geoclue.Base.DiscoverLocation-class.html#on_address_changed
Geoclue.Base.DiscoverLocation.set_requirements Geoclue.Base.DiscoverLocation-class.html#set_requirements
Geoclue.Base.DiscoverLocation.provider_info Geoclue.Base.DiscoverLocation-class.html#provider_info
Geoclue.Base.DiscoverLocation.compare_position Geoclue.Base.DiscoverLocation-class.html#compare_position
Geoclue.Base.DiscoverLocation.init Geoclue.Base.DiscoverLocation-class.html#init
Geoclue.Base.DiscoverLocation.get_position_provider Geoclue.Base.DiscoverLocation-class.html#get_position_provider
Geoclue.Base.DiscoverLocation.connect Geoclue.Base.DiscoverLocation-class.html#connect
Geoclue.Base.DiscoverLocation.set_position_provider Geoclue.Base.DiscoverLocation-class.html#set_position_provider
Geoclue.Base.DiscoverLocation.reverse_position Geoclue.Base.DiscoverLocation-class.html#reverse_position
Geoclue.Base.DiscoverLocation.update_location_address Geoclue.Base.DiscoverLocation-class.html#update_location_address
Geoclue.Base.DiscoverLocation.get_available_providers Geoclue.Base.DiscoverLocation-class.html#get_available_providers
Geoclue.Base.DiscoverLocation.__init__ Geoclue.Base.DiscoverLocation-class.html#__init__
Geoclue.Base.DiscoverLocation.validate_address Geoclue.Base.DiscoverLocation-class.html#validate_address
Geoclue.Signal.Accumulator Geoclue.Signal.Accumulator-class.html
Geoclue.Signal.Accumulator.__call__ Geoclue.Signal.Accumulator-class.html#__call__
Geoclue.Signal.Accumulator.finalize Geoclue.Signal.Accumulator-class.html#finalize
Geoclue.Signal.Slot Geoclue.Signal.Slot-class.html
Geoclue.Signal.Slot.__call__ Geoclue.Signal.Slot-class.html#__call__
Geoclue.Signal.Slot.__init__ Geoclue.Signal.Slot-class.html#__init__
Geoclue.Signal'.Signal Geoclue.Signal%27.Signal-class.html
Geoclue.Signal'.Signal.Slot Geoclue.Signal.Slot-class.html
Geoclue.Signal'.Signal.disconnect_all Geoclue.Signal%27.Signal-class.html#disconnect_all
Geoclue.Signal'.Signal.disconnect Geoclue.Signal%27.Signal-class.html#disconnect
Geoclue.Signal'.Signal.create_accumulator Geoclue.Signal%27.Signal-class.html#create_accumulator
Geoclue.Signal'.Signal.Accumulator Geoclue.Signal.Accumulator-class.html
Geoclue.Signal'.Signal.connect Geoclue.Signal%27.Signal-class.html#connect
Geoclue.Signal'.Signal.__call__ Geoclue.Signal%27.Signal-class.html#__call__
Geoclue.Signal'.Signal.find Geoclue.Signal%27.Signal-class.html#find
Geoclue.Signal'.Signal.__init__ Geoclue.Signal%27.Signal-class.html#__init__
Geoclue.Signal'.Signal.new_connection Geoclue.Signal%27.Signal-class.html#new_connection
Geoclue.geoclue.GeoclueProvider Geoclue.geoclue.GeoclueProvider-class.html
Geoclue.geoclue.GeoclueProvider.get_proxy Geoclue.geoclue.GeoclueProvider-class.html#get_proxy
Geoclue.geoclue.GeoclueProvider.__init__ Geoclue.geoclue.GeoclueProvider-class.html#__init__
python-geoclue/docs/redirect.html 0000644 0001750 0001750 00000002300 11245331631 017215 0 ustar pcabido pcabido Epydoc Redirect Page
Epydoc Auto-redirect page
When javascript is enabled, this page will redirect URLs of
the form redirect.html#dotted.name to the
documentation for the object with the given fully-qualified
dotted name.
1# -*- coding: utf-8 -*- 2# Copyright (c) 2009 - Paulo Cabido <paulo.cabido@gmail.com> 3# 4# This program is free software: you can redistribute it and/or modify it under 5# the terms of the GNU General Public License as published by the Free Software 6# Foundation, either version 3 of the License, or (at your option) any later 7# version. 8# 9# This program is distributed in the hope that it will be useful, but WITHOUT10# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS11# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more12# details.13#14# You should have received a copy of the GNU General Public License along with15# this program. If not, see <http://www.gnu.org/licenses/>.1617importrandom18
1# -*- coding: utf-8 -*- 2# Copyright (c) 2009 - Paulo Cabido <paulo.cabido@gmail.com> 3# 4# This program is free software: you can redistribute it and/or modify it under 5# the terms of the GNU General Public License as published by the Free Software 6# Foundation, either version 3 of the License, or (at your option) any later 7# version. 8# 9# This program is distributed in the hope that it will be useful, but WITHOUT 10# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 11# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 12# details. 13# 14# You should have received a copy of the GNU General Public License along with 15# this program. If not, see <http://www.gnu.org/licenses/>. 16 17importos 18importsys 19importmath 20 21importdbus 22fromdbus.mainloop.glibimportDBusGMainLoop 23importgobject 24 25importgeoclue 26fromSignalimportSignal 27 28DBusGMainLoop(set_as_default=True) 29
31""" Discovers the location form the best available provider 32 33 L{DiscoverLocation} is a object that provides a nice API interface 34 for Geoclue. 35 """ 36
38"""Construct a L{DiscoverLocation} object. 39 40 @param providers_path: The path to the providers. The default 41 path to the providers is /usr/share/geoclue-providers. 42 """ 43self.bus=dbus.SessionBus() 44 45self.signal=Signal() 46 47# stores the location info 48self.location_info={} 49 50# Insipered by Pierre-Luc Beaudoin - geoclue_properties.py 51# TODO: add an exception to this part of the code in case of the wrong 52# or nonexisting dir 53self.providers=[] 54 55dir=os.listdir(providers_path) 56 57forfilenameindir: 58(name,ext)=os.path.splitext(filename) 59 60ifext==".provider": 61complete=os.path.join(providers_path,filename) 62provider=geoclue.GeoclueProvider(complete) 63self.providers.append([provider, 64provider.name, 65provider.interfaces&geoclue.INTERFACE_ADDRESS, 66provider.interfaces&geoclue.INTERFACE_POSITION, 67provider.interfaces&geoclue.INTERFACE_GEOCODE, 68provider.interfaces&geoclue.INTERFACE_REVERSE_GEOCODE, 69provider.service, 70provider.path 71])
136"""Returns the provider's Info.137138 @return: A dictionary with the provider's name and descripiton.139 """140obj=dbus.Interface(provider.get_proxy(),dbus_interface=geoclue.GEOCLUE_IFACE)141info=obj.GetProviderInfo()142tmp={}143tmp['name']=str(info[0])144tmp['description']=str(info[1])145returntmp
148"""Set the client requirements.149150 @param accuracy: The required minimum accuracy.151 @param time: The minimum time between update signals.152 @param require_updates: C{True} if updates are required or C{False} if updates 153 are not required.154 @param resource: The resources that are allowed to be used.155 """156self.accuracy=accuracy157self.resource=resource158self.client.SetRequirements(accuracy,time,require_updates,allowed_resources)
159160# provider changed methods, not really being used but it's useful to have 161# them here just in case
171"""Updates the the location's address with the given C{address}.172173 @address: The new address.174 """175ifaddress.has_key('street'):176self.location_info['street']=address['street']177178# TODO: postalcode ?179180ifaddress.has_key('area'):181self.locatio_infon['area']=address['area']182183ifaddress.has_key('locality'):184self.location_info['locality']=address['locality']185186ifaddress.has_key('country'):187self.location_info['country']=address['country']188189ifaddress.has_key('region'):190self.location_info['region']=address['region']191192ifaddress.has_key('countrycode'):193self.location_info['countrycode']=address['countrycode']
196"""When the address changes the location info dictionary is updated.197198 @param timestamp: The timestamp.199 @param address: The new address.200 @accuracy: The accuracy.201 """202self.location_info['address_timestamp']=timestamp203self.update_location_address(address)204self.signal()
207"""When the position changes the location info dictionary is updated.208209 @param fields: The fields.210 @param timestamp: The timestamp.211 @param latitude: The new latitude.212 @param longitude: The new longitude.213 @param altitude: The new altitude.214 @param accuracy: The accuracy.215 """216#print accuracy # I used this print to check the accuracy format217self.location_info['position_timestamp']=timestamp218self.location_info['latitude']=latitude219self.location_info['longitude']=longitude220self.location_info['altitude']=altitude221self.signal()
222223# returns the current values for location and position
232"""Returns the available providers.233234 @return: A list of dictionarys,235 [PROVIDER, ADDRESS, POSITION, GEOCODING, REVERSE GEOCODING],236 with the name and True of False for supporting each of them237 """238current_providers=[]239forproviderinself.providers:240tmp={}241tmp['name']=provider[1]242ifprovider[2]!=0:243tmp['address']=True244else:245tmp['address']=False246247ifprovider[3]!=0:248tmp['position']=True249else:250tmp['position']=False251252ifprovider[4]!=0:253tmp['geocoding']=True254else:255tmp['geocoding']=False256257ifprovider[5]!=0:258tmp['revgeocoding']=True259else:260tmp['revgeocoding']=False261262tmp['object']=provider[0]263tmp['service']=provider[6]264tmp['path']=provider[7]265266current_providers.append(tmp)267268returncurrent_providers
271"""Set the position provider to a given C{provider_name} (if exists).272273 @param provider_name: The provider's name274 @return: C{True} if the provider exists or C{False} if a provider275 does not exist.276 """277provider_exists=False278forproviderinself.providers:279ifprovider[1].lower()==provider_name.lower()andprovider[3]!=0:280current_provider=provider281provider_exists=True282break283284ifnotprovider_exists:285returnFalse286287try:288tmp_provider=current_provider[0].get_proxy()289self.position=dbus.Interface(tmp_provider,dbus_interface=geoclue.POSITION_IFACE)290exceptException,e:291print"D-Bus error: %s"%e292returnFalse293294try:295self.on_position_changed(*self.position.GetPosition())296exceptException,e:297printe298299returnTrue
302"""Receives the address and validates/corrects it.303304 @param address: The address dictionary.305 @return: The address (with possible corrections).306 """307tmp_address={}308ifaddress.has_key('street'):309tmp_address['street']=address['street']310else:311tmp_address['street']=""312313# TODO: postalcode ?314315ifaddress.has_key('area'):316tmp_address['area']=address['area']317else:318tmp_address['area']=""319320ifaddress.has_key('locality'):321tmp_address['locality']=address['locality']322else:323tmp_address['locality']=""324325ifaddress.has_key('country'):326tmp_address['country']=address['country']327else:328tmp_address['country']=""329330ifaddress.has_key('region'):331tmp_address['region']=address['region']332else:333tmp_address['region']=""334335ifaddress.has_key('countrycode'):336tmp_address['countrycode']=address['countrycode']337else:338tmp_address['countrycode']=""339340returntmp_address
341342# TODO: add "valid-for" to continue to use the given provider
344"""Set the address provider345346 @param provider_name: the provider's name347 @param address: the new address (for Manual and Localnet providers)348 @returns: C{True} if the provider exists or C{False} if a provider349 does not exist.350 """351provider_exists=False352forproviderinself.providers:353ifprovider[1].lower()==provider_name.lower()andprovider[2]!=0:354current_provider=provider355provider_exists=True356break357358ifnotprovider_exists:359returnFalse360361try:362if(provider_name.lower()=="manual"orprovider_name.lower()=="localnet")andaddress!=None:363tmp_provider=current_provider[0].get_proxy()364tmp_provider.SetAddress(0,self.validate_address(address))365self.address=dbus.Interface(tmp_provider,dbus_interface=geoclue.ADDRESS_IFACE)366elif(provider_name.lower()=="manual"orprovider_name.lower()=="localnet")andaddress==None:367returnFalse368else:369self.address=dbus.Interface(current_provider[0].get_proxy(),dbus_interface=geoclue.ADDRESS_IFACE)370exceptException,e:371print"D-Bus error: %s"%e372returnFalse373374try:375self.on_address_changed(*self.address.GetAddress())376exceptException,e:377printe378379returnTrue
382"""Returns the name of the current position provider.383384 @return: The name of the current position provider.385 """386returnself.client.GetPositionProvider()[0]
389"""Returns the name of the current address provider.390391 @return: The name of the current address provider.392 """393returnself.client.GetAddressProvider()[0]
396"""Compare the current position to a given position.397398 Note: ploum's contribution399400 @param latitude: latitude of the position401 @param longitude: longitude of the position402 @param proximity_factor: the near by proximity factor. ie, 0.5 is 500 meters403 """404ifproximity_factor==None:405# 500 meters406dis_max=0.5407else:408dis_max=proximity_factor409410# todo_later : (calibration must be done with a well known distance )411#This method assumes a spheroidal model for the earth with 412#an average radius of 6364.963 km. 413#The formula is estimated to have an accuracy of about 200 metres 414#over 50 km, but may deteriorate with longer distances.415#source : http://www.ga.gov.au/geodesy/datums/distance.jsp416dl=self.location_info['latitude']-latitude417dg=self.location_info['longitude']-longitude418term1=111.08956*(dl+0.000001)419term2=math.cos(self.location_info['latitude']+(dl/2))420term3=(dg+0.000001)/(dl+0.000001)421d=term1/math.cos(math.atan(term2*term3))422result=math.fabs(d)<dis_max423returnresult
426"""Returns an address that corresponds to a given position.427428 @param latitude: The position's latitude. 429 @param longitude: The position's longitude.430 @param accuracy: The accuracy.431 @return: An address.432 """433provider_exists=False434forproviderinself.providers:435ifprovider[1].lower()=="Geonames Provider".lower():436current_provider=provider437provider_exists=True438break439440ifnotprovider_exists:441returnNone442443try:444revgeocoder=dbus.Interface(current_provider[0].get_proxy(),geoclue.REVERSE_IFACE)445revaddress=revgeocoder.PositionToAddress(float(latitude),float(longitude),(accuracy,0,0))446447#add the values to the address of the location variable448tmp_address={}449forkey,iteminrevaddress[0].items():450tmp_address[unicode(key)]=unicode(item)451452returnself.validate_address(tmp_address)453exceptException,e:454print"D-Bus error: %s"%e455returnNone
458"""Connects a given function to the signal.459 The signal action if any change to the info location dictionary.460461 @param func: The function to connect to the signal.462 """463self.signal.connect(func)
466"""Disconnects a given function from the signal.467468 @param func: The function to disconnect from the signal.469 """470self.signal.disconnect(func)
1# -*- coding: utf-8 -*- 2# Copyright (c) 2009 - Paulo Cabido <paulo.cabido@gmail.com> 3# 4# This program is free software: you can redistribute it and/or modify it under 5# the terms of the GNU General Public License as published by the Free Software 6# Foundation, either version 3 of the License, or (at your option) any later 7# version. 8# 9# This program is distributed in the hope that it will be useful, but WITHOUT10# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS11# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more12# details.13#14# You should have received a copy of the GNU General Public License along with15# this program. If not, see <http://www.gnu.org/licenses/>.1617fromBaseimport*1819VERSION="0.1"20
on_position_changed(self,
fields,
timestamp,
latitude,
longitude,
altitude,
accuracy)
When the position changes the location info dictionary is updated.
This document contains the API (Application Programming Interface)
documentation for this project. Documentation for the Python
objects defined by the project is divided into separate pages for each
package, module, and class. The API documentation also includes two
pages containing information about the project as a whole: a trees
page, and an index page.
Object Documentation
Each Package Documentation page contains:
A description of the package.
A list of the modules and sub-packages contained by the
package.
A summary of the classes defined by the package.
A summary of the functions defined by the package.
A summary of the variables defined by the package.
A detailed description of each function defined by the
package.
A detailed description of each variable defined by the
package.
Each Module Documentation page contains:
A description of the module.
A summary of the classes defined by the module.
A summary of the functions defined by the module.
A summary of the variables defined by the module.
A detailed description of each function defined by the
module.
A detailed description of each variable defined by the
module.
Each Class Documentation page contains:
A class inheritance diagram.
A list of known subclasses.
A description of the class.
A summary of the methods defined by the class.
A summary of the instance variables defined by the class.
A summary of the class (static) variables defined by the
class.
A detailed description of each method defined by the
class.
A detailed description of each instance variable defined by the
class.
A detailed description of each class (static) variable defined
by the class.
Project Documentation
The Trees page contains the module and class hierarchies:
The module hierarchy lists every package and module, with
modules grouped into packages. At the top level, and within each
package, modules and sub-packages are listed alphabetically.
The class hierarchy lists every class, grouped by base
class. If a class has more than one base class, then it will be
listed under each base class. At the top level, and under each base
class, classes are listed alphabetically.
The Index page contains indices of terms and
identifiers:
The term index lists every term indexed by any object's
documentation. For each term, the index provides links to each
place where the term is indexed.
The identifier index lists the (short) name of every package,
module, class, method, function, variable, and parameter. For each
identifier, the index provides a short description, and a link to
its documentation.
The Table of Contents
The table of contents occupies the two frames on the left side of
the window. The upper-left frame displays the project
contents, and the lower-left frame displays the module
contents:
Project Contents...
API Documentation Frame
Module Contents ...
The project contents frame contains a list of all packages
and modules that are defined by the project. Clicking on an entry
will display its contents in the module contents frame. Clicking on a
special entry, labeled "Everything," will display the contents of
the entire project.
The module contents frame contains a list of every
submodule, class, type, exception, function, and variable defined by a
module or package. Clicking on an entry will display its
documentation in the API documentation frame. Clicking on the name of
the module, at the top of the frame, will display the documentation
for the module itself.
The "frames" and "no frames" buttons below the top
navigation bar can be used to control whether the table of contents is
displayed or not.
The Navigation Bar
A navigation bar is located at the top and bottom of every page.
It indicates what type of page you are currently viewing, and allows
you to go to related pages. The following table describes the labels
on the navigation bar. Note that not some labels (such as
[Parent]) are not displayed on all pages.
Label
Highlighted when...
Links to...
[Parent]
(never highlighted)
the parent of the current package
[Package]
viewing a package
the package containing the current object
[Module]
viewing a module
the module containing the current object
[Class]
viewing a class
the class containing the current object
[Trees]
viewing the trees page
the trees page
[Index]
viewing the index page
the index page
[Help]
viewing the help page
the help page
The "show private" and "hide private" buttons below
the top navigation bar can be used to control whether documentation
for private objects is displayed. Private objects are usually defined
as objects whose (short) names begin with a single underscore, but do
not end with an underscore. For example, "_x",
"__pprint", and "epydoc.epytext._tokenize"
are private objects; but "re.sub",
"__init__", and "type_" are not. However,
if a module defines the "__all__" variable, then its
contents are used to decide which objects are private.
A timestamp below the bottom navigation bar indicates when each
page was last updated.
python-geoclue/docs/crarr.png 0000644 0001750 0001750 00000000524 11245331631 016353 0 ustar pcabido pcabido PNG
IHDR
eE ,tEXtCreation Time Tue 22 Aug 2006 00:43:10 -0500` X tIME)} pHYs nu> gAMA a EPLTEðf4sW ЊrD`@ bCܖX{`,lNo@xdE螊dƴ~Twv tRNS @f MIDATxc`@0&+ (;; /EXؑ? n b;'+Y# (r<" IENDB` python-geoclue/docs/epydoc.js 0000644 0001750 0001750 00000024525 11245331631 016364 0 ustar pcabido pcabido function toggle_private() {
// Search for any private/public links on this page. Store
// their old text in "cmd," so we will know what action to
// take; and change their text to the opposite action.
var cmd = "?";
var elts = document.getElementsByTagName("a");
for(var i=0; i... ";
elt.innerHTML = s;
}
}
function toggle(id) {
elt = document.getElementById(id+"-toggle");
if (elt.innerHTML == "-")
collapse(id);
else
expand(id);
return false;
}
function highlight(id) {
var elt = document.getElementById(id+"-def");
if (elt) elt.className = "py-highlight-hdr";
var elt = document.getElementById(id+"-expanded");
if (elt) elt.className = "py-highlight";
var elt = document.getElementById(id+"-collapsed");
if (elt) elt.className = "py-highlight";
}
function num_lines(s) {
var n = 1;
var pos = s.indexOf("\n");
while ( pos > 0) {
n += 1;
pos = s.indexOf("\n", pos+1);
}
return n;
}
// Collapse all blocks that mave more than `min_lines` lines.
function collapse_all(min_lines) {
var elts = document.getElementsByTagName("div");
for (var i=0; i 0)
if (elt.id.substring(split, elt.id.length) == "-expanded")
if (num_lines(elt.innerHTML) > min_lines)
collapse(elt.id.substring(0, split));
}
}
function expandto(href) {
var start = href.indexOf("#")+1;
if (start != 0 && start != href.length) {
if (href.substring(start, href.length) != "-") {
collapse_all(4);
pos = href.indexOf(".", start);
while (pos != -1) {
var id = href.substring(start, pos);
expand(id);
pos = href.indexOf(".", pos+1);
}
var id = href.substring(start, href.length);
expand(id);
highlight(id);
}
}
}
function kill_doclink(id) {
var parent = document.getElementById(id);
parent.removeChild(parent.childNodes.item(0));
}
function auto_kill_doclink(ev) {
if (!ev) var ev = window.event;
if (!this.contains(ev.toElement)) {
var parent = document.getElementById(this.parentID);
parent.removeChild(parent.childNodes.item(0));
}
}
function doclink(id, name, targets_id) {
var elt = document.getElementById(id);
// If we already opened the box, then destroy it.
// (This case should never occur, but leave it in just in case.)
if (elt.childNodes.length > 1) {
elt.removeChild(elt.childNodes.item(0));
}
else {
// The outer box: relative + inline positioning.
var box1 = document.createElement("div");
box1.style.position = "relative";
box1.style.display = "inline";
box1.style.top = 0;
box1.style.left = 0;
// A shadow for fun
var shadow = document.createElement("div");
shadow.style.position = "absolute";
shadow.style.left = "-1.3em";
shadow.style.top = "-1.3em";
shadow.style.background = "#404040";
// The inner box: absolute positioning.
var box2 = document.createElement("div");
box2.style.position = "relative";
box2.style.border = "1px solid #a0a0a0";
box2.style.left = "-.2em";
box2.style.top = "-.2em";
box2.style.background = "white";
box2.style.padding = ".3em .4em .3em .4em";
box2.style.fontStyle = "normal";
box2.onmouseout=auto_kill_doclink;
box2.parentID = id;
// Get the targets
var targets_elt = document.getElementById(targets_id);
var targets = targets_elt.getAttribute("targets");
var links = "";
target_list = targets.split(",");
for (var i=0; i" +
target[0] + "";
}
// Put it all together.
elt.insertBefore(box1, elt.childNodes.item(0));
//box1.appendChild(box2);
box1.appendChild(shadow);
shadow.appendChild(box2);
box2.innerHTML =
"Which "+name+" do you want to see documentation for?" +
"
";
}
return false;
}
function get_anchor() {
var href = location.href;
var start = href.indexOf("#")+1;
if ((start != 0) && (start != href.length))
return href.substring(start, href.length);
}
function redirect_url(dottedName) {
// Scan through each element of the "pages" list, and check
// if "name" matches with any of them.
for (var i=0; i-m" or "-c";
// extract the portion & compare it to dottedName.
var pagename = pages[i].substring(0, pages[i].length-2);
if (pagename == dottedName.substring(0,pagename.length)) {
// We've found a page that matches `dottedName`;
// construct its URL, using leftover `dottedName`
// content to form an anchor.
var pagetype = pages[i].charAt(pages[i].length-1);
var url = pagename + ((pagetype=="m")?"-module.html":
"-class.html");
if (dottedName.length > pagename.length)
url += "#" + dottedName.substring(pagename.length+1,
dottedName.length);
return url;
}
}
}
python-geoclue/docs/epydoc.css 0000644 0001750 0001750 00000037227 11245331631 016543 0 ustar pcabido pcabido
/* Epydoc CSS Stylesheet
*
* This stylesheet can be used to customize the appearance of epydoc's
* HTML output.
*
*/
/* Default Colors & Styles
* - Set the default foreground & background color with 'body'; and
* link colors with 'a:link' and 'a:visited'.
* - Use bold for decision list terms.
* - The heading styles defined here are used for headings *within*
* docstring descriptions. All headings used by epydoc itself use
* either class='epydoc' or class='toc' (CSS styles for both
* defined below).
*/
body { background: #ffffff; color: #000000; }
p { margin-top: 0.5em; margin-bottom: 0.5em; }
a:link { color: #0000ff; }
a:visited { color: #204080; }
dt { font-weight: bold; }
h1 { font-size: +140%; font-style: italic;
font-weight: bold; }
h2 { font-size: +125%; font-style: italic;
font-weight: bold; }
h3 { font-size: +110%; font-style: italic;
font-weight: normal; }
code { font-size: 100%; }
/* N.B.: class, not pseudoclass */
a.link { font-family: monospace; }
/* Page Header & Footer
* - The standard page header consists of a navigation bar (with
* pointers to standard pages such as 'home' and 'trees'); a
* breadcrumbs list, which can be used to navigate to containing
* classes or modules; options links, to show/hide private
* variables and to show/hide frames; and a page title (using
*
). The page title may be followed by a link to the
* corresponding source code (using 'span.codelink').
* - The footer consists of a navigation bar, a timestamp, and a
* pointer to epydoc's homepage.
*/
h1.epydoc { margin: 0; font-size: +140%; font-weight: bold; }
h2.epydoc { font-size: +130%; font-weight: bold; }
h3.epydoc { font-size: +115%; font-weight: bold;
margin-top: 0.2em; }
td h3.epydoc { font-size: +115%; font-weight: bold;
margin-bottom: 0; }
table.navbar { background: #a0c0ff; color: #000000;
border: 2px groove #c0d0d0; }
table.navbar table { color: #000000; }
th.navbar-select { background: #70b0ff;
color: #000000; }
table.navbar a { text-decoration: none; }
table.navbar a:link { color: #0000ff; }
table.navbar a:visited { color: #204080; }
span.breadcrumbs { font-size: 85%; font-weight: bold; }
span.options { font-size: 70%; }
span.codelink { font-size: 85%; }
td.footer { font-size: 85%; }
/* Table Headers
* - Each summary table and details section begins with a 'header'
* row. This row contains a section title (marked by
* 'span.table-header') as well as a show/hide private link
* (marked by 'span.options', defined above).
* - Summary tables that contain user-defined groups mark those
* groups using 'group header' rows.
*/
td.table-header { background: #70b0ff; color: #000000;
border: 1px solid #608090; }
td.table-header table { color: #000000; }
td.table-header table a:link { color: #0000ff; }
td.table-header table a:visited { color: #204080; }
span.table-header { font-size: 120%; font-weight: bold; }
th.group-header { background: #c0e0f8; color: #000000;
text-align: left; font-style: italic;
font-size: 115%;
border: 1px solid #608090; }
/* Summary Tables (functions, variables, etc)
* - Each object is described by a single row of the table with
* two cells. The left cell gives the object's type, and is
* marked with 'code.summary-type'. The right cell gives the
* object's name and a summary description.
* - CSS styles for the table's header and group headers are
* defined above, under 'Table Headers'
*/
table.summary { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090;
margin-bottom: 0.5em; }
td.summary { border: 1px solid #608090; }
code.summary-type { font-size: 85%; }
table.summary a:link { color: #0000ff; }
table.summary a:visited { color: #204080; }
/* Details Tables (functions, variables, etc)
* - Each object is described in its own div.
* - A single-row summary table w/ table-header is used as
* a header for each details section (CSS style for table-header
* is defined above, under 'Table Headers').
*/
table.details { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090;
margin: .2em 0 0 0; }
table.details table { color: #000000; }
table.details a:link { color: #0000ff; }
table.details a:visited { color: #204080; }
/* Fields */
dl.fields { margin-left: 2em; margin-top: 1em;
margin-bottom: 1em; }
dl.fields dd ul { margin-left: 0em; padding-left: 0em; }
dl.fields dd ul li ul { margin-left: 2em; padding-left: 0em; }
div.fields { margin-left: 2em; }
div.fields p { margin-bottom: 0.5em; }
/* Index tables (identifier index, term index, etc)
* - link-index is used for indices containing lists of links
* (namely, the identifier index & term index).
* - index-where is used in link indices for the text indicating
* the container/source for each link.
* - metadata-index is used for indices containing metadata
* extracted from fields (namely, the bug index & todo index).
*/
table.link-index { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090; }
td.link-index { border-width: 0px; }
table.link-index a:link { color: #0000ff; }
table.link-index a:visited { color: #204080; }
span.index-where { font-size: 70%; }
table.metadata-index { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090;
margin: .2em 0 0 0; }
td.metadata-index { border-width: 1px; border-style: solid; }
table.metadata-index a:link { color: #0000ff; }
table.metadata-index a:visited { color: #204080; }
/* Function signatures
* - sig* is used for the signature in the details section.
* - .summary-sig* is used for the signature in the summary
* table, and when listing property accessor functions.
* */
.sig-name { color: #006080; }
.sig-arg { color: #008060; }
.sig-default { color: #602000; }
.summary-sig { font-family: monospace; }
.summary-sig-name { color: #006080; font-weight: bold; }
table.summary a.summary-sig-name:link
{ color: #006080; font-weight: bold; }
table.summary a.summary-sig-name:visited
{ color: #006080; font-weight: bold; }
.summary-sig-arg { color: #006040; }
.summary-sig-default { color: #501800; }
/* Subclass list
*/
ul.subclass-list { display: inline; }
ul.subclass-list li { display: inline; }
/* To render variables, classes etc. like functions */
table.summary .summary-name { color: #006080; font-weight: bold;
font-family: monospace; }
table.summary
a.summary-name:link { color: #006080; font-weight: bold;
font-family: monospace; }
table.summary
a.summary-name:visited { color: #006080; font-weight: bold;
font-family: monospace; }
/* Variable values
* - In the 'variable details' sections, each varaible's value is
* listed in a 'pre.variable' box. The width of this box is
* restricted to 80 chars; if the value's repr is longer than
* this it will be wrapped, using a backslash marked with
* class 'variable-linewrap'. If the value's repr is longer
* than 3 lines, the rest will be ellided; and an ellipsis
* marker ('...' marked with 'variable-ellipsis') will be used.
* - If the value is a string, its quote marks will be marked
* with 'variable-quote'.
* - If the variable is a regexp, it is syntax-highlighted using
* the re* CSS classes.
*/
pre.variable { padding: .5em; margin: 0;
background: #dce4ec; color: #000000;
border: 1px solid #708890; }
.variable-linewrap { color: #604000; font-weight: bold; }
.variable-ellipsis { color: #604000; font-weight: bold; }
.variable-quote { color: #604000; font-weight: bold; }
.variable-group { color: #008000; font-weight: bold; }
.variable-op { color: #604000; font-weight: bold; }
.variable-string { color: #006030; }
.variable-unknown { color: #a00000; font-weight: bold; }
.re { color: #000000; }
.re-char { color: #006030; }
.re-op { color: #600000; }
.re-group { color: #003060; }
.re-ref { color: #404040; }
/* Base tree
* - Used by class pages to display the base class hierarchy.
*/
pre.base-tree { font-size: 80%; margin: 0; }
/* Frames-based table of contents headers
* - Consists of two frames: one for selecting modules; and
* the other listing the contents of the selected module.
* - h1.toc is used for each frame's heading
* - h2.toc is used for subheadings within each frame.
*/
h1.toc { text-align: center; font-size: 105%;
margin: 0; font-weight: bold;
padding: 0; }
h2.toc { font-size: 100%; font-weight: bold;
margin: 0.5em 0 0 -0.3em; }
/* Syntax Highlighting for Source Code
* - doctest examples are displayed in a 'pre.py-doctest' block.
* If the example is in a details table entry, then it will use
* the colors specified by the 'table pre.py-doctest' line.
* - Source code listings are displayed in a 'pre.py-src' block.
* Each line is marked with 'span.py-line' (used to draw a line
* down the left margin, separating the code from the line
* numbers). Line numbers are displayed with 'span.py-lineno'.
* The expand/collapse block toggle button is displayed with
* 'a.py-toggle' (Note: the CSS style for 'a.py-toggle' should not
* modify the font size of the text.)
* - If a source code page is opened with an anchor, then the
* corresponding code block will be highlighted. The code
* block's header is highlighted with 'py-highlight-hdr'; and
* the code block's body is highlighted with 'py-highlight'.
* - The remaining py-* classes are used to perform syntax
* highlighting (py-string for string literals, py-name for names,
* etc.)
*/
pre.py-doctest { padding: .5em; margin: 1em;
background: #e8f0f8; color: #000000;
border: 1px solid #708890; }
table pre.py-doctest { background: #dce4ec;
color: #000000; }
pre.py-src { border: 2px solid #000000;
background: #f0f0f0; color: #000000; }
.py-line { border-left: 2px solid #000000;
margin-left: .2em; padding-left: .4em; }
.py-lineno { font-style: italic; font-size: 90%;
padding-left: .5em; }
a.py-toggle { text-decoration: none; }
div.py-highlight-hdr { border-top: 2px solid #000000;
border-bottom: 2px solid #000000;
background: #d8e8e8; }
div.py-highlight { border-bottom: 2px solid #000000;
background: #d0e0e0; }
.py-prompt { color: #005050; font-weight: bold;}
.py-more { color: #005050; font-weight: bold;}
.py-string { color: #006030; }
.py-comment { color: #003060; }
.py-keyword { color: #600000; }
.py-output { color: #404040; }
.py-name { color: #000050; }
.py-name:link { color: #000050 !important; }
.py-name:visited { color: #000050 !important; }
.py-number { color: #005000; }
.py-defname { color: #000060; font-weight: bold; }
.py-def-name { color: #000060; font-weight: bold; }
.py-base-class { color: #000060; }
.py-param { color: #000060; }
.py-docstring { color: #006030; }
.py-decorator { color: #804020; }
/* Use this if you don't want links to names underlined: */
/*a.py-name { text-decoration: none; }*/
/* Graphs & Diagrams
* - These CSS styles are used for graphs & diagrams generated using
* Graphviz dot. 'img.graph-without-title' is used for bare
* diagrams (to remove the border created by making the image
* clickable).
*/
img.graph-without-title { border: none; }
img.graph-with-title { border: 1px solid #000000; }
span.graph-title { font-weight: bold; }
span.graph-caption { }
/* General-purpose classes
* - 'p.indent-wrapped-lines' defines a paragraph whose first line
* is not indented, but whose subsequent lines are.
* - The 'nomargin-top' class is used to remove the top margin (e.g.
* from lists). The 'nomargin' class is used to remove both the
* top and bottom margin (but not the left or right margin --
* for lists, that would cause the bullets to disappear.)
*/
p.indent-wrapped-lines { padding: 0 0 0 7em; text-indent: -7em;
margin: 0; }
.nomargin-top { margin-top: 0; }
.nomargin { margin-top: 0; margin-bottom: 0; }
/* HTML Log */
div.log-block { padding: 0; margin: .5em 0 .5em 0;
background: #e8f0f8; color: #000000;
border: 1px solid #000000; }
div.log-error { padding: .1em .3em .1em .3em; margin: 4px;
background: #ffb0b0; color: #000000;
border: 1px solid #000000; }
div.log-warning { padding: .1em .3em .1em .3em; margin: 4px;
background: #ffffb0; color: #000000;
border: 1px solid #000000; }
div.log-info { padding: .1em .3em .1em .3em; margin: 4px;
background: #b0ffb0; color: #000000;
border: 1px solid #000000; }
h2.log-hdr { background: #70b0ff; color: #000000;
margin: 0; padding: 0em 0.5em 0em 0.5em;
border-bottom: 1px solid #000000; font-size: 110%; }
p.log { font-weight: bold; margin: .5em 0 .5em 0; }
tr.opt-changed { color: #000000; font-weight: bold; }
tr.opt-default { color: #606060; }
pre.log { margin: 0; padding: 0; padding-left: 1em; }