summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst64
1 files changed, 64 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..af97029
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,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>`_