summaryrefslogtreecommitdiffstats
path: root/README.rst
blob: af970292ada7f15a8a132da860342ce245cf8a27 (plain)
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
Pytzdata
########

.. image:: https://travis-ci.org/sdispater/pytzdata.png
   :alt: Pytzdata Build status
   :target: https://travis-ci.org/sdispater/pytzdata

The Olson timezone database for Python.

Supports Python **2.7+** and **3.5+**.


Installation
============

    pip install pytzdata


Usage
=====

You can access the content of a specific timezone file by using the `tz_file()` function:

.. code-block:: python

    from pytzdata import tz_file

    with tz_file('Europe/Paris') as f:
        # Do something with the file

If you just want to know the path to a specific timezone file, you may use the `tz_path()` function:

.. code-block:: python

    from pytzdata import tz_path

    tz_path('Europe/Paris')

By default, ``pytzdata`` will use the bundled timezone database, however you can set
a custom directory that holds the timezone files using the ``set_directory`` function:

.. code-block:: python

    import pytzdata

    pytzdata.set_directory('/custom/zoneinfo')

You can also set the ``PYTZDATA_TZDATADIR`` environment variable to set a custom directory.


Release
=======

To make a new release just follow these steps:

- ``make data``
- Update version numbers in ``pytzdata/version.py`` and ``tests/test_version.py``
- ``make tox``


Resources
=========

* `Issue Tracker <https://github.com/sdispater/pytzdata/issues>`_