Skip to content

Commit 5e1ab36

Browse files
michaeljohnbarrmichaeljohnbarr
committed
Preparation for version 0.6 release. Primarily a documentation release, but also refactored underlying code base to simplify, added tests, added minor features, made PEP257 changes.
1 parent c31f114 commit 5e1ab36

14 files changed

+1187
-33
lines changed

‎docs/Makefile

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
# User-friendly check for sphinx-build
11+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13+
endif
14+
15+
# Internal variables.
16+
PAPEROPT_a4 = -D latex_paper_size=a4
17+
PAPEROPT_letter = -D latex_paper_size=letter
18+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19+
# the i18n builder cannot share the environment and doctrees with the others
20+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21+
22+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23+
24+
help:
25+
@echo "Please use \`make <target>' where <target> is one of"
26+
@echo " html to make standalone HTML files"
27+
@echo " dirhtml to make HTML files named index.html in directories"
28+
@echo " singlehtml to make a single large HTML file"
29+
@echo " pickle to make pickle files"
30+
@echo " json to make JSON files"
31+
@echo " htmlhelp to make HTML files and a HTML help project"
32+
@echo " qthelp to make HTML files and a qthelp project"
33+
@echo " devhelp to make HTML files and a Devhelp project"
34+
@echo " epub to make an epub"
35+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
37+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38+
@echo " text to make text files"
39+
@echo " man to make manual pages"
40+
@echo " texinfo to make Texinfo files"
41+
@echo " info to make Texinfo files and run them through makeinfo"
42+
@echo " gettext to make PO message catalogs"
43+
@echo " changes to make an overview of all changed/added/deprecated items"
44+
@echo " xml to make Docutils-native XML files"
45+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
46+
@echo " linkcheck to check all external links for integrity"
47+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
48+
49+
clean:
50+
rm -rf $(BUILDDIR)/*
51+
52+
html:
53+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54+
@echo
55+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56+
57+
dirhtml:
58+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59+
@echo
60+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61+
62+
singlehtml:
63+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64+
@echo
65+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66+
67+
pickle:
68+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69+
@echo
70+
@echo "Build finished; now you can process the pickle files."
71+
72+
json:
73+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74+
@echo
75+
@echo "Build finished; now you can process the JSON files."
76+
77+
htmlhelp:
78+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79+
@echo
80+
@echo "Build finished; now you can run HTML Help Workshop with the" \
81+
".hhp project file in $(BUILDDIR)/htmlhelp."
82+
83+
qthelp:
84+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85+
@echo
86+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
87+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DjangoTimezoneUtils.qhcp"
89+
@echo "To view the help file:"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DjangoTimezoneUtils.qhc"
91+
92+
devhelp:
93+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94+
@echo
95+
@echo "Build finished."
96+
@echo "To view the help file:"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/DjangoTimezoneUtils"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DjangoTimezoneUtils"
99+
@echo "# devhelp"
100+
101+
epub:
102+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103+
@echo
104+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105+
106+
latex:
107+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108+
@echo
109+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
111+
"(use \`make latexpdf' here to do that automatically)."
112+
113+
latexpdf:
114+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115+
@echo "Running LaTeX files through pdflatex..."
116+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
117+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118+
119+
latexpdfja:
120+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121+
@echo "Running LaTeX files through platex and dvipdfmx..."
122+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124+
125+
text:
126+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127+
@echo
128+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
129+
130+
man:
131+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132+
@echo
133+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134+
135+
texinfo:
136+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137+
@echo
138+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139+
@echo "Run \`make' in that directory to run these through makeinfo" \
140+
"(use \`make info' here to do that automatically)."
141+
142+
info:
143+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144+
@echo "Running Texinfo files through makeinfo..."
145+
make -C $(BUILDDIR)/texinfo info
146+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147+
148+
gettext:
149+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150+
@echo
151+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152+
153+
changes:
154+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155+
@echo
156+
@echo "The overview file is in $(BUILDDIR)/changes."
157+
158+
linkcheck:
159+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160+
@echo
161+
@echo "Link check complete; look for any errors in the above output " \
162+
"or in $(BUILDDIR)/linkcheck/output.txt."
163+
164+
doctest:
165+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166+
@echo "Testing of doctests in the sources finished, look at the " \
167+
"results in $(BUILDDIR)/doctest/output.txt."
168+
169+
xml:
170+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171+
@echo
172+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173+
174+
pseudoxml:
175+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176+
@echo
177+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎docs/choices.rst

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
=======
2+
Choices
3+
=======
4+
Contains constants and functions to generate model/form choices for time zones.
5+
6+
Constants
7+
=========
8+
9+
``ALL_TIMEZONES_CHOICES``
10+
-------------------------
11+
.. |pytz.all_timezones| replace:: ``pytz.all_timezones``
12+
.. _pytz.all_timezones: http://pytz.sourceforge.net/#helpers
13+
14+
.. py:data:: ALL_TIMEZONE_CHOICES
15+
16+
Returns choices directly populated from |pytz.all_timezones|_.
17+
18+
.. code-block:: python
19+
20+
>>> from timezone_utils.choices import ALL_TIMEZONES_CHOICES
21+
>>> print ALL_TIMEZONES_CHOICES
22+
(
23+
('Africa/Abidjan', 'Africa/Abidjan'),
24+
('Africa/Accra', 'Africa/Accra'),
25+
('Africa/Addis_Ababa', 'Africa/Addis_Ababa'),
26+
('Africa/Algiers', 'Africa/Algiers'),
27+
('Africa/Asmara', 'Africa/Asmara'),
28+
('Africa/Asmera', 'Africa/Asmera'),
29+
('Africa/Bamako', 'Africa/Bamako'),
30+
('Africa/Bangui', 'Africa/Bangui'),
31+
('Africa/Banjul', 'Africa/Banjul'),
32+
('Africa/Bissau', 'Africa/Bissau'),
33+
...
34+
)
35+
36+
``COMMON_TIMEZONES_CHOICES``
37+
----------------------------
38+
.. |pytz.common_timezones| replace:: ``pytz.common_timezones``
39+
.. _pytz.common_timezones: http://pytz.sourceforge.net/#helpers
40+
41+
.. py:data:: COMMON_TIMEZONE_CHOICES
42+
43+
Returns choices directly populated from |pytz.common_timezones|_.
44+
45+
.. code-block:: python
46+
47+
>>> from timezone_utils.choices import COMMON_TIMEZONES_CHOICES
48+
>>> print COMMON_TIMEZONES_CHOICES
49+
(
50+
('Africa/Abidjan', 'Africa/Abidjan'),
51+
('Africa/Accra', 'Africa/Accra'),
52+
('Africa/Addis_Ababa', 'Africa/Addis_Ababa'),
53+
('Africa/Algiers', 'Africa/Algiers'),
54+
('Africa/Asmara', 'Africa/Asmara'),
55+
('Africa/Bamako', 'Africa/Bamako'),
56+
('Africa/Bangui', 'Africa/Bangui'),
57+
('Africa/Banjul', 'Africa/Banjul'),
58+
('Africa/Bissau', 'Africa/Bissau'),
59+
('Africa/Blantyre', 'Africa/Blantyre'),
60+
...
61+
)
62+
63+
``PRETTY_ALL_TIMEZONES_CHOICES``
64+
--------------------------------
65+
.. py:data:: PRETTY_ALL_TIMEZONES_CHOICES
66+
67+
Returns choices formatted for display ordered by their timezone offsets
68+
populated from |pytz.all_timezones|_.
69+
70+
.. code-block:: python
71+
72+
>>> from timezone_utils.choices import PRETTY_ALL_TIMEZONES_CHOICES
73+
>>> print PRETTY_ALL_TIMEZONES_CHOICES
74+
(
75+
('Etc/GMT+12', '(GMT-12:00) Etc/GMT+12'),
76+
('Etc/GMT+11', '(GMT-11:00) Etc/GMT+11'),
77+
('Pacific/Midway', '(GMT-11:00) Pacific/Midway'),
78+
('Pacific/Niue', '(GMT-11:00) Pacific/Niue'),
79+
('Pacific/Pago_Pago', '(GMT-11:00) Pacific/Pago_Pago'),
80+
('Pacific/Samoa', '(GMT-11:00) Pacific/Samoa'),
81+
('US/Samoa', '(GMT-11:00) US/Samoa'),
82+
('America/Adak', '(GMT-10:00) America/Adak'),
83+
('America/Atka', '(GMT-10:00) America/Atka'),
84+
('Etc/GMT+10', '(GMT-10:00) Etc/GMT+10'),
85+
...
86+
)
87+
88+
``PRETTY_COMMON_TIMEZONES_CHOICES``
89+
-----------------------------------
90+
.. py:data:: PRETTY_COMMON_TIMEZONES_CHOICES
91+
92+
Returns choices formatted for display ordered by their timezone offsets
93+
populated from |pytz.common_timezones|_.
94+
95+
.. code-block:: python
96+
97+
>>> from timezone_utils.choices import PRETTY_COMMON_TIMEZONES_CHOICES
98+
>>> print PRETTY_COMMON_TIMEZONES_CHOICES
99+
(
100+
('Pacific/Midway', '(GMT-11:00) Pacific/Midway'),
101+
('Pacific/Niue', '(GMT-11:00) Pacific/Niue'),
102+
('Pacific/Pago_Pago', '(GMT-11:00) Pacific/Pago_Pago'),
103+
('America/Adak', '(GMT-10:00) America/Adak'),
104+
('Pacific/Honolulu', '(GMT-10:00) Pacific/Honolulu'),
105+
('Pacific/Johnston', '(GMT-10:00) Pacific/Johnston'),
106+
('Pacific/Rarotonga', '(GMT-10:00) Pacific/Rarotonga'),
107+
('Pacific/Tahiti', '(GMT-10:00) Pacific/Tahiti'),
108+
('US/Hawaii', '(GMT-10:00) US/Hawaii'),
109+
('Pacific/Marquesas', '(GMT-09:30) Pacific/Marquesas'),
110+
...
111+
)
112+
113+
Functions
114+
=========
115+
116+
``get_choices(timezones)``
117+
--------------------------
118+
.. py:function:: get_choices(timezones)
119+
120+
Retrieves timezone choices from any iterable (normally from `pytz <pytz.sourceforge.net/>`_).
121+
122+
:param timezones: Any iterable that contains valid Olson Time Zone strings.
123+
:type timezones: iterable
124+
:return: A tuple containing tuples of time zone choices.
125+
:rtype: tuple
126+
:raises pytz.exceptions.UnknownTimeZoneError: if the string from the iterable ``timezones``
127+
parameter is not recognized as a valid Olson time zone.
128+
:raises TypeError: if the ``timezones`` parameter is not iterable.
129+
130+
Using ``get_choices(timezones)`` for custom time zone choices
131+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132+
If you want to limit choices to a particular country (as an example), you could
133+
do this:
134+
135+
.. code-block:: python
136+
137+
>>> import pytz
138+
>>> from timezone_utils.choices import get_choices
139+
>>> choices = get_choices(pytz.country_timezones('US'))
140+
>>> print choices
141+
(
142+
(u'America/Adak', '(GMT-10:00) America/Adak'),
143+
(u'Pacific/Honolulu', '(GMT-10:00) Pacific/Honolulu'),
144+
(u'America/Anchorage', '(GMT-09:00) America/Anchorage'),
145+
(u'America/Juneau', '(GMT-09:00) America/Juneau'),
146+
(u'America/Nome', '(GMT-09:00) America/Nome'),
147+
(u'America/Sitka', '(GMT-09:00) America/Sitka'),
148+
(u'America/Yakutat', '(GMT-09:00) America/Yakutat'),
149+
(u'America/Los_Angeles', '(GMT-08:00) America/Los_Angeles'),
150+
(u'America/Metlakatla', '(GMT-08:00) America/Metlakatla'),
151+
(u'America/Boise', '(GMT-07:00) America/Boise'),
152+
(u'America/Denver', '(GMT-07:00) America/Denver'),
153+
...
154+
)

0 commit comments

Comments
 (0)