File: README.rst

package info (click to toggle)
python-gammu 3.2.4-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,032 kB
  • sloc: ansic: 11,446; python: 3,323; sql: 527; makefile: 6
file content (102 lines) | stat: -rw-r--r-- 3,172 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
python-gammu
============

Python bindings for the `Gammu library <https://wammu.eu/gammu/>`_.

.. image:: https://github.com/gammu/python-gammu/actions/workflows/test.yml/badge.svg
    :target: https://github.com/gammu/python-gammu/actions/workflows/test.yml

.. image:: https://api.codacy.com/project/badge/Grade/c7e87df480fb4609aa48482873f5c46b
    :target: https://www.codacy.com/app/Gammu/python-gammu

.. image:: https://coveralls.io/repos/gammu/python-gammu/badge.svg
    :target: https://coveralls.io/r/gammu/python-gammu

.. image:: https://scan.coverity.com/projects/4837/badge.svg
    :target: https://scan.coverity.com/projects/4837

.. image:: https://img.shields.io/liberapay/receives/Gammu.svg
    :alt: Liberapay
    :target: https://liberapay.com/Gammu/donate

.. image:: https://www.bountysource.com/badge/team?team_id=23177&style=bounties_received
    :alt: Bountysource
    :target: https://www.bountysource.com/teams/gammu/issues?utm_source=Gammu&utm_medium=shield&utm_campaign=bounties_received

.. image:: https://img.shields.io/pypi/v/python-gammu.svg
    :alt: PyPI
    :target: https://pypi.python.org/pypi/python-gammu/

Homepage
========

<https://wammu.eu/python-gammu/>

License
=======

Copyright (C) 2003 - 2018 Michal Cihar

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 2 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, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Installing
==========

You can install in a usual way for Python modules using distutils, so use
``setup.py`` which is placed in the top level directory::

    ./setup.py build
    sudo ./setup.py install

You can also install it using pip installer::

    pip install python-gammu

Requirements
============

To compile python-gammu, you need Gammu development files (usually shipped as
``libgammu-dev`` or ``gammu-devel`` in Linux distributions).

The location of the libraries is discovered using ``pkg-config``,
``GAMMU_PATH`` environment variable and falls back to generic locations. In
case it does not work, either install ``pkg-config`` or set ``GAMMU_PATH``.

On Linux something like this should work::

    GAMMU_PATH=/opt/gammu python setup.py build

On Windows::

    SET GAMMU_PATH="C:\Gammu"
    python setup.py build


Documentation
=============

Please see included python documentation::

    >>> import gammu
    >>> help(gammu)

Alternatively you can use Sphinx to generate browsable version, which is
also available on-line at <https://wammu.eu/docs/manual/>.

Feedback and bug reports
========================

Any feedback is welcome, see <https://wammu.eu/support/> for information
how to contact developers.