i3geoweather


Namei3geoweather JSON
Version 1.1.2 PyPI version JSON
download
home_pagehttps://github.com/joergdietrich/i3geoweather
SummaryProvide temperature information to i3blocks based on geolocated IP address
upload_time2022-12-20 10:32:21
maintainer
docs_urlNone
authorJörg Dietrich
requires_python
licenseMIT
keywords i3 i3wm i3blocks i3blocks-scripts weather-app geolocation weather
VCS
bugtrack_url
requirements requests
Travis-CI No Travis.
coveralls test coverage No coveralls.
            i3geoweather
============

This blocklet provides temperature information for the i3blocks status bar
often used in the i3 window manager. It attempts to determine your location
based on your IP address using the `ipinfo.io <http://ipinfo.io>`_
API. Based on the location it retrieves weather information from the free
`openweathermap.org API`__.

.. _openweathermap: http://api.openweathermap.org/

__ openweathermap_

.. image:: docs/i3geoweather.jpg
   :width: 800px
   :target: docs/i3geoweather.jpg

i3geoweather is a pure Python 3 program. No attempt to make it compatible with
Python 2 has been or will be made. It is time to switch!


Installation
------------

The easiest way to install i3geoweather is to use pip::

  $ pip install i3geoweather

Depending on your system you may need to call pip3 instead of pip


Dependencies
------------

i3geoweather depends on the Python requests_ library. i3geoweather output uses
`FontAwesome <http://fontawesome.io>`_ for its output. You should download the
free FontAwesome zip file and copy fontawesome-webfont.ttf to your ~/.fonts/
directory. 

Usage
-----

i3geoweather runs a daemon process in the background (if started with the -d
option) and periodically updates weather information by writing to
~/.i3geoweather/i3geoweather.txt.

Start i3geoweather from your i3 configuration file::

  exec_always i3geoweather -d

You may need to use the full path to i3geoweather, e.g., for an installation
with pip install --user ...::

  exec_always ~/.local/bin/i3geoweather -d

A typical i3blocks.conf entry may look like this::

  [weather]
  interval=repeat
  command=inotifywait -qq -e delete_self ~/.i3geoweather/i3geoweather.txt && cat ~/.i3geoweather/i3geoweather.txt

Command line options:

- -d or --daemon run as background process
- -l or --location force a location by specifying a comma separated
  latitude/longitude pair, e.g., -l "50.0126, 7.996". North and east are
  positive. 
- -r or --restart restart background process
- -s or --stop stop running background process
- -v increase verbosity of logging to ~/.i3geoweather/i3geoweather.log. Can be
  used up to three times. Using -v twice logs informational
  messages. Debugging output is produced when -v is used three times.



Author
------

Jörg Dietrich joerg@joergdietrich.com

Contributing
------------

Development takes place on GitHub_. Please report any bugs as an issue in the
GitHub issue tracker.

License
-------

i3geoweather is released under an MIT license. See LICENCE.txt


.. _requests: http://docs.python-requests.org/en/master/
.. _GitHub: https://github.com/joergdietrich/i3geoweather



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/joergdietrich/i3geoweather",
    "name": "i3geoweather",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "i3 i3wm i3blocks i3blocks-scripts weather-app geolocation weather",
    "author": "J\u00f6rg Dietrich",
    "author_email": "joerg@joergdietrich.com",
    "download_url": "https://files.pythonhosted.org/packages/b1/7b/d497f77e09167a07e95aad912224492371b860ea7803ca4d5c6eb4206e58/i3geoweather-1.1.2.tar.gz",
    "platform": null,
    "description": "i3geoweather\n============\n\nThis blocklet provides temperature information for the i3blocks status bar\noften used in the i3 window manager. It attempts to determine your location\nbased on your IP address using the `ipinfo.io <http://ipinfo.io>`_\nAPI. Based on the location it retrieves weather information from the free\n`openweathermap.org API`__.\n\n.. _openweathermap: http://api.openweathermap.org/\n\n__ openweathermap_\n\n.. image:: docs/i3geoweather.jpg\n   :width: 800px\n   :target: docs/i3geoweather.jpg\n\ni3geoweather is a pure Python 3 program. No attempt to make it compatible with\nPython 2 has been or will be made. It is time to switch!\n\n\nInstallation\n------------\n\nThe easiest way to install i3geoweather is to use pip::\n\n  $ pip install i3geoweather\n\nDepending on your system you may need to call pip3 instead of pip\n\n\nDependencies\n------------\n\ni3geoweather depends on the Python requests_ library. i3geoweather output uses\n`FontAwesome <http://fontawesome.io>`_ for its output. You should download the\nfree FontAwesome zip file and copy fontawesome-webfont.ttf to your ~/.fonts/\ndirectory. \n\nUsage\n-----\n\ni3geoweather runs a daemon process in the background (if started with the -d\noption) and periodically updates weather information by writing to\n~/.i3geoweather/i3geoweather.txt.\n\nStart i3geoweather from your i3 configuration file::\n\n  exec_always i3geoweather -d\n\nYou may need to use the full path to i3geoweather, e.g., for an installation\nwith pip install --user ...::\n\n  exec_always ~/.local/bin/i3geoweather -d\n\nA typical i3blocks.conf entry may look like this::\n\n  [weather]\n  interval=repeat\n  command=inotifywait -qq -e delete_self ~/.i3geoweather/i3geoweather.txt && cat ~/.i3geoweather/i3geoweather.txt\n\nCommand line options:\n\n- -d or --daemon run as background process\n- -l or --location force a location by specifying a comma separated\n  latitude/longitude pair, e.g., -l \"50.0126, 7.996\". North and east are\n  positive. \n- -r or --restart restart background process\n- -s or --stop stop running background process\n- -v increase verbosity of logging to ~/.i3geoweather/i3geoweather.log. Can be\n  used up to three times. Using -v twice logs informational\n  messages. Debugging output is produced when -v is used three times.\n\n\n\nAuthor\n------\n\nJ\u00f6rg Dietrich joerg@joergdietrich.com\n\nContributing\n------------\n\nDevelopment takes place on GitHub_. Please report any bugs as an issue in the\nGitHub issue tracker.\n\nLicense\n-------\n\ni3geoweather is released under an MIT license. See LICENCE.txt\n\n\n.. _requests: http://docs.python-requests.org/en/master/\n.. _GitHub: https://github.com/joergdietrich/i3geoweather\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Provide temperature information to i3blocks based on geolocated IP address",
    "version": "1.1.2",
    "split_keywords": [
        "i3",
        "i3wm",
        "i3blocks",
        "i3blocks-scripts",
        "weather-app",
        "geolocation",
        "weather"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "200c425455f96ba0136a4e0bc41d9df5",
                "sha256": "c73233b58d5431ce69f267bb308e1cd9404a53b64d973fd0d20eff5a78f29d55"
            },
            "downloads": -1,
            "filename": "i3geoweather-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "200c425455f96ba0136a4e0bc41d9df5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8524,
            "upload_time": "2022-12-20T10:30:45",
            "upload_time_iso_8601": "2022-12-20T10:30:45.189561Z",
            "url": "https://files.pythonhosted.org/packages/13/b3/018d72a94c9b8b5c17bb262796e71baedc4105468cef3d5252c242668eaf/i3geoweather-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "bd5216c3519534d89bca6aec9d1c8b33",
                "sha256": "63055e392e691b72524e13c571fb5a5c81aa4d5e03dd82194d670bc31e13dfc7"
            },
            "downloads": -1,
            "filename": "i3geoweather-1.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "bd5216c3519534d89bca6aec9d1c8b33",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8053,
            "upload_time": "2022-12-20T10:32:21",
            "upload_time_iso_8601": "2022-12-20T10:32:21.226899Z",
            "url": "https://files.pythonhosted.org/packages/b1/7b/d497f77e09167a07e95aad912224492371b860ea7803ca4d5c6eb4206e58/i3geoweather-1.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-20 10:32:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "joergdietrich",
    "github_project": "i3geoweather",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "requests",
            "specs": [
                [
                    ">=",
                    "2.22.0"
                ]
            ]
        }
    ],
    "lcname": "i3geoweather"
}
        
Elapsed time: 0.02243s