70 |
71 |
77 |
78 |
79 |
80 |
--------------------------------------------------------------------------------
/update.py:
--------------------------------------------------------------------------------
1 | import redis
2 | import json
3 | import urllib2
4 | import datetime
5 | from calendar import timegm
6 | import time
7 | import os
8 | import sys
9 |
10 | REDIS_URL = os.getenv('REDISTOGO_URL', 'redis://localhost:6379')
11 | r = redis.StrictRedis.from_url(REDIS_URL)
12 |
13 | # NASA's station FDO updates this page with very precise data. Only using a
14 | # small bit of it for now.
15 | url = "http://spaceflight.nasa.gov/realdata/sightings/SSapplications/Post/JavaSSOP/orbit/ISS/SVPOST.html"
16 |
17 |
18 | def update_tle():
19 | # Open a http request
20 | req = urllib2.Request(url)
21 | response = urllib2.urlopen(req)
22 | data = response.read()
23 |
24 | # parse the HTML
25 | data = data.split("
")[1]
26 | data = data.split("
")[0]
27 | data = data.split("Vector Time (GMT): ")[1:]
28 |
29 | for group in data:
30 | # Time the vector is valid for
31 | datestr = group[0:17]
32 |
33 | # parse date string
34 | tm = time.strptime(datestr, "%Y/%j/%H:%M:%S")
35 |
36 | # change into more useful datetime object
37 | dt = datetime.datetime(tm[0], tm[1], tm[2], tm[3], tm[4], tm[5])
38 |
39 | # Debug
40 | #print dt
41 |
42 | # More parsing
43 | tle = group.split("TWO LINE MEAN ELEMENT SET")[1]
44 | tle = tle[8:160]
45 | lines = tle.split('\n')[0:3]
46 |
47 | # Most recent TLE
48 | now = datetime.datetime.utcnow()
49 |
50 | if (dt - now).days >= 0:
51 | # Debug Printing
52 | """
53 | print dt
54 | for line in lines:
55 | print line.strip()
56 | print "\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n"
57 | """
58 |
59 | tle = json.dumps([lines[0].strip(), lines[1].strip(), lines[2].strip()])
60 |
61 | r.set("iss_tle", tle)
62 | r.set("iss_tle_time", timegm(dt.timetuple()))
63 | r.set("iss_tle_last_update", timegm(now.timetuple()))
64 | break
65 |
66 |
67 | if __name__ == '__main__':
68 | print "Updating ISS TLE from JSC..."
69 | try:
70 | update_tle()
71 | except:
72 | exctype, value = sys.exc_info()[:2]
73 | print "Error:", exctype, value
74 |
--------------------------------------------------------------------------------
/testsuite/api.py:
--------------------------------------------------------------------------------
1 | from unittest import main, TestCase
2 | from flask.ext.webtest import TestApp
3 | import json
4 | from app import app
5 |
6 |
7 | class IssNowTest(TestCase):
8 | """Test the ISS-now API"""
9 |
10 | def setUp(self):
11 | self.app = app
12 | self.w = TestApp(self.app)
13 |
14 | def test_load(self):
15 | # Test the endpoints
16 | r = self.w.get('/iss-now.json')
17 | self.assertFalse(r.flashes)
18 | r = self.w.get('/iss-now/')
19 | self.assertFalse(r.flashes)
20 | r = self.w.get('/iss-now/v1')
21 | self.assertFalse(r.flashes)
22 |
23 | def test_data(self):
24 | r = self.w.get('/iss-now.json')
25 | r.charset = 'utf8'
26 | try:
27 | data = json.loads(r.text)
28 | except:
29 | self.fail("ISS API not a valid JSON responce")
30 |
31 | # Success message
32 | self.assertEqual(data['message'], "success", "ISS API Did not return 'sucess' message")
33 |
34 | # timestamp exists
35 | self.assertTrue('timestamp' in data)
36 |
37 | # position data
38 | self.assertTrue('iss_position' in data)
39 | self.assertTrue('latitude' in data['iss_position'])
40 | self.assertTrue('longitude' in data['iss_position'])
41 |
42 |
43 | class AstrosTest(TestCase):
44 | """Test the number of astros API"""
45 |
46 | def setUp(self):
47 | self.app = app
48 | self.w = TestApp(self.app)
49 |
50 | def test_load_astros(self):
51 | r = self.w.get('/astros.json')
52 | self.assertFalse(r.flashes)
53 | r = self.w.get('/astros/')
54 | self.assertFalse(r.flashes)
55 | r = self.w.get('/astros/v1')
56 | self.assertFalse(r.flashes)
57 |
58 | def test_data(self):
59 | r = self.w.get('/astros.json')
60 | r.charset = 'utf8'
61 | try:
62 | data = json.loads(r.text)
63 | except:
64 | self.fail("ISS API not a valid JSON responce")
65 |
66 | # Success message
67 | self.assertEqual(data['message'], "success", "ISS API Did not return 'sucess' message")
68 |
69 | # data exists
70 | self.assertTrue('number' in data)
71 | self.assertEqual(type(data['number']), int)
72 | self.assertTrue('people' in data)
73 |
--------------------------------------------------------------------------------
/README.markdown:
--------------------------------------------------------------------------------
1 | # Open Nofity APIs
2 |
3 | 
4 | [](https://travis-ci.org/open-notify/Open-Notify-API)
5 | [](https://requires.io/github/open-notify/Open-Notify-API/requirements/?branch=master)
6 | [](http://open-notify-api.readthedocs.org/)
7 |
8 |
9 | APIs for [api.open-notify.org](http://api.open-notify.org)
10 |
11 |
12 | ## Install for the first time:
13 |
14 | Make sure you have some packages:
15 |
16 | # apt-get install python python-dev python-pip virtualenvwrapper redis-server
17 |
18 | Note: if you're installing `virtualenvwrapper` for the first time, be sure to log out and back in before continuing.
19 |
20 | Create a virtual environment
21 |
22 | $ mkvirtualenv opennotify
23 | (opennotify)$ pip install -r requirements.txt
24 |
25 | Get data
26 |
27 | (opennotify)$ python update.py
28 |
29 |
30 | ## Run locally:
31 |
32 | Start virtual environment
33 |
34 | $ workon opennotify
35 |
36 | Run with [foreman](https://github.com/ddollar/foreman) using dev procfile:
37 |
38 | (opennotify)$ foreman start -f Procfile.dev
39 |
40 | Open a browser to [localhost:5000](http://localhost:5000).
41 |
42 |
43 | ## Run Testsuite
44 |
45 | (opennotify)$ cd testsuite
46 | (opennotify)$ pip install -r requirements.txt
47 | (opennotify)$ cd ..
48 | (opennotify)$ make test
49 |
50 |
51 | ## API Documentation
52 |
53 | Docs are in the gh-pages branch, or on the web here:
54 |
55 | - [Open Notify API Documentation](http://open-notify.org/Open-Notify-API/)
56 |
57 |
58 | ## License
59 |
60 | Copyright (C) 2016 Nathan Bergey
61 |
62 | This program is free software: you can redistribute it and/or modify
63 | it under the terms of the GNU General Public License as published by
64 | the Free Software Foundation, either version 3 of the License, or
65 | (at your option) any later version.
66 |
67 | This program is distributed in the hope that it will be useful,
68 | but WITHOUT ANY WARRANTY; without even the implied warranty of
69 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
70 | GNU General Public License for more details.
71 |
72 | You should have received a copy of the GNU General Public License
73 | along with this program. If not, see .
74 |
--------------------------------------------------------------------------------
/iss.py:
--------------------------------------------------------------------------------
1 | import ephem
2 | import datetime
3 | from calendar import timegm
4 | from math import degrees
5 | import redis
6 | import json
7 | import os
8 |
9 | REDIS_URL = os.getenv('REDISTOGO_URL', 'redis://localhost:6379')
10 | r = redis.StrictRedis.from_url(REDIS_URL)
11 |
12 |
13 | def get_location():
14 | """Compute the current location of the ISS"""
15 |
16 | # Get latest TLE from redis
17 | tle = json.loads(r.get("iss_tle"))
18 | iss = ephem.readtle(str(tle[0]), str(tle[1]), str(tle[2]))
19 |
20 | # Compute for now
21 | now = datetime.datetime.utcnow()
22 | iss.compute(now)
23 | lon = degrees(iss.sublong)
24 | lat = degrees(iss.sublat)
25 |
26 | # Return the relevant timestamp and data
27 | return {"timestamp": timegm(now.timetuple()), "iss_position": {"latitude": lat, "longitude": lon}}
28 |
29 |
30 | def get_tle():
31 | """Grab the current TLE"""
32 | return json.loads(r.get("iss_tle"))
33 |
34 |
35 | def get_tle_time():
36 | """Grab the current TLE time"""
37 | return r.get("iss_tle_time")
38 |
39 |
40 | def get_tle_update():
41 | """Grab the tle update time"""
42 | return r.get("iss_tle_last_update")
43 |
44 |
45 | def get_passes(lon, lat, alt, n):
46 | """Compute n number of passes of the ISS for a location"""
47 |
48 | # Get latest TLE from redis
49 | tle = json.loads(r.get("iss_tle"))
50 | iss = ephem.readtle(str(tle[0]), str(tle[1]), str(tle[2]))
51 |
52 | # Set location
53 | location = ephem.Observer()
54 | location.lat = str(lat)
55 | location.long = str(lon)
56 | location.elevation = alt
57 |
58 | # Override refration calculation
59 | location.pressure = 0
60 | location.horizon = '10:00'
61 |
62 | # Set time now
63 | now = datetime.datetime.utcnow()
64 | location.date = now
65 |
66 | # Predict passes
67 | passes = []
68 | for p in xrange(n):
69 | tr, azr, tt, altt, ts, azs = location.next_pass(iss)
70 | duration = int((ts - tr) * 60 * 60 * 24)
71 | year, month, day, hour, minute, second = tr.tuple()
72 | dt = datetime.datetime(year, month, day, hour, minute, int(second))
73 |
74 | if duration > 60:
75 | passes.append({"risetime": timegm(dt.timetuple()), "duration": duration})
76 |
77 | # Increase the time by more than a pass and less than an orbit
78 | location.date = tr + 25*ephem.minute
79 |
80 | # Return object
81 | obj = {"request": {
82 | "datetime": timegm(now.timetuple()),
83 | "latitude": lat,
84 | "longitude": lon,
85 | "altitude": alt,
86 | "passes": n,
87 | },
88 | "response": passes,
89 | }
90 |
91 | return obj
92 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
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 | # Internal variables.
11 | PAPEROPT_a4 = -D latex_paper_size=a4
12 | PAPEROPT_letter = -D latex_paper_size=letter
13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14 | # the i18n builder cannot share the environment and doctrees with the others
15 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16 |
17 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18 |
19 | help:
20 | @echo "Please use \`make ' where is one of"
21 | @echo " html to make standalone HTML files"
22 | @echo " dirhtml to make HTML files named index.html in directories"
23 | @echo " singlehtml to make a single large HTML file"
24 | @echo " pickle to make pickle files"
25 | @echo " json to make JSON files"
26 | @echo " htmlhelp to make HTML files and a HTML help project"
27 | @echo " qthelp to make HTML files and a qthelp project"
28 | @echo " devhelp to make HTML files and a Devhelp project"
29 | @echo " epub to make an epub"
30 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31 | @echo " latexpdf to make LaTeX files and run them through pdflatex"
32 | @echo " text to make text files"
33 | @echo " man to make manual pages"
34 | @echo " texinfo to make Texinfo files"
35 | @echo " info to make Texinfo files and run them through makeinfo"
36 | @echo " gettext to make PO message catalogs"
37 | @echo " changes to make an overview of all changed/added/deprecated items"
38 | @echo " linkcheck to check all external links for integrity"
39 | @echo " doctest to run all doctests embedded in the documentation (if enabled)"
40 |
41 | clean:
42 | -rm -rf $(BUILDDIR)/*
43 |
44 | html:
45 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46 | @echo
47 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48 |
49 | dirhtml:
50 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51 | @echo
52 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53 |
54 | singlehtml:
55 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56 | @echo
57 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58 |
59 | pickle:
60 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61 | @echo
62 | @echo "Build finished; now you can process the pickle files."
63 |
64 | json:
65 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66 | @echo
67 | @echo "Build finished; now you can process the JSON files."
68 |
69 | htmlhelp:
70 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71 | @echo
72 | @echo "Build finished; now you can run HTML Help Workshop with the" \
73 | ".hhp project file in $(BUILDDIR)/htmlhelp."
74 |
75 | qthelp:
76 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77 | @echo
78 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \
79 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PSASTelemetryServer.qhcp"
81 | @echo "To view the help file:"
82 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PSASTelemetryServer.qhc"
83 |
84 | devhelp:
85 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86 | @echo
87 | @echo "Build finished."
88 | @echo "To view the help file:"
89 | @echo "# mkdir -p $$HOME/.local/share/devhelp/PSASTelemetryServer"
90 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PSASTelemetryServer"
91 | @echo "# devhelp"
92 |
93 | epub:
94 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95 | @echo
96 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97 |
98 | latex:
99 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100 | @echo
101 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102 | @echo "Run \`make' in that directory to run these through (pdf)latex" \
103 | "(use \`make latexpdf' here to do that automatically)."
104 |
105 | latexpdf:
106 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107 | @echo "Running LaTeX files through pdflatex..."
108 | $(MAKE) -C $(BUILDDIR)/latex all-pdf
109 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110 |
111 | text:
112 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113 | @echo
114 | @echo "Build finished. The text files are in $(BUILDDIR)/text."
115 |
116 | man:
117 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118 | @echo
119 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120 |
121 | texinfo:
122 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123 | @echo
124 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125 | @echo "Run \`make' in that directory to run these through makeinfo" \
126 | "(use \`make info' here to do that automatically)."
127 |
128 | info:
129 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130 | @echo "Running Texinfo files through makeinfo..."
131 | make -C $(BUILDDIR)/texinfo info
132 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133 |
134 | gettext:
135 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136 | @echo
137 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138 |
139 | changes:
140 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141 | @echo
142 | @echo "The overview file is in $(BUILDDIR)/changes."
143 |
144 | linkcheck:
145 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146 | @echo
147 | @echo "Link check complete; look for any errors in the above output " \
148 | "or in $(BUILDDIR)/linkcheck/output.txt."
149 |
150 | doctest:
151 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152 | @echo "Testing of doctests in the sources finished, look at the " \
153 | "results in $(BUILDDIR)/doctest/output.txt."
154 |
--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | import sys, os
3 | sys.path.insert(0, os.path.abspath('..'))
4 | import app
5 | from better import better_theme_path
6 | html_theme_path = [better_theme_path]
7 | html_theme = 'better'
8 |
9 | # -- General configuration -----------------------------------------------------
10 | extensions = [
11 | 'sphinx.ext.autodoc',
12 | 'sphinx.ext.todo',
13 | 'sphinxcontrib.httpdomain',
14 | 'sphinxcontrib.autohttp.flask',
15 | ]
16 |
17 | # Add any paths that contain templates here, relative to this directory.
18 | templates_path = ['_templates']
19 |
20 | # The suffix of source filenames.
21 | source_suffix = '.rst'
22 |
23 | # The encoding of source files.
24 | source_encoding = 'utf-8-sig'
25 |
26 | # The master toctree document.
27 | master_doc = 'index'
28 |
29 | # General information about the project.
30 | project = u'Open Notify API'
31 | copyright = u'2016, @natronics'
32 |
33 | version = 0.2
34 | release = 0.2
35 |
36 | add_module_names = True
37 | html_use_smartypants = True
38 | html_use_modindex = True
39 | html_use_index = True
40 |
41 |
42 | # The language for content autogenerated by Sphinx. Refer to documentation
43 | # for a list of supported languages.
44 | #language = None
45 |
46 | exclude_patterns = ['_build']
47 |
48 | # The reST default role (used for this markup: `text`) to use for all documents.
49 | #default_role = None
50 |
51 | # If true, '()' will be appended to :func: etc. cross-reference text.
52 | #add_function_parentheses = True
53 |
54 | # If true, the current module name will be prepended to all description
55 | # unit titles (such as .. function::).
56 | #add_module_names = True
57 |
58 | # If true, sectionauthor and moduleauthor directives will be shown in the
59 | # output. They are ignored by default.
60 | #show_authors = False
61 |
62 | # The name of the Pygments (syntax highlighting) style to use.
63 | pygments_style = 'sphinx'
64 |
65 | # A list of ignored prefixes for module index sorting.
66 | #modindex_common_prefix = []
67 |
68 |
69 | # -- Options for HTML output ---------------------------------------------------
70 | """
71 | on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
72 | if on_rtd:
73 | html_theme = 'default'
74 | else:
75 | import sphinx_rtd_theme
76 | html_theme = "sphinx_rtd_theme"
77 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
78 | """
79 |
80 | # The name of an image file (relative to this directory) to place at the top
81 | # of the sidebar.
82 | html_logo = 'open-notify.png'
83 |
84 | # The name of an image file (within the static path) to use as favicon of the
85 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
86 | # pixels large.
87 | #html_favicon = None
88 |
89 | # Add any paths that contain custom static files (such as style sheets) here,
90 | # relative to this directory. They are copied after the builtin static files,
91 | # so a file named "default.css" will overwrite the builtin "default.css".
92 | html_static_path = ['_static']
93 |
94 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
95 | # using the given strftime format.
96 | #html_last_updated_fmt = '%b %d, %Y'
97 |
98 | # If true, SmartyPants will be used to convert quotes and dashes to
99 | # typographically correct entities.
100 | #html_use_smartypants = True
101 |
102 | # Custom sidebar templates, maps document names to template names.
103 | #html_sidebars = {}
104 |
105 | # Additional templates that should be rendered to pages, maps page names to
106 | # template names.
107 | #html_additional_pages = {}
108 |
109 | # If false, no module index is generated.
110 | #html_domain_indices = True
111 |
112 | # If false, no index is generated.
113 | #html_use_index = True
114 |
115 | # If true, the index is split into individual pages for each letter.
116 | #html_split_index = False
117 |
118 | # If true, links to the reST sources are added to the pages.
119 | #html_show_sourcelink = True
120 |
121 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
122 | #html_show_sphinx = True
123 |
124 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
125 | #html_show_copyright = True
126 |
127 | # If true, an OpenSearch description file will be output, and all pages will
128 | # contain a tag referring to it. The value of this option must be the
129 | # base URL from which the finished HTML is served.
130 | #html_use_opensearch = ''
131 |
132 | # This is the file name suffix for HTML files (e.g. ".xhtml").
133 | #html_file_suffix = None
134 |
135 | # Output file base name for HTML help builder.
136 | htmlhelp_basename = 'Open Notify API'
137 |
138 |
139 | # -- Options for LaTeX output --------------------------------------------------
140 |
141 | latex_elements = {
142 | # The paper size ('letterpaper' or 'a4paper').
143 | #'papersize': 'letterpaper',
144 |
145 | # The font size ('10pt', '11pt' or '12pt').
146 | #'pointsize': '10pt',
147 |
148 | # Additional stuff for the LaTeX preamble.
149 | #'preamble': '',
150 | }
151 |
152 | # Grouping the document tree into LaTeX files. List of tuples
153 | # (source start file, target name, title, author, documentclass [howto/manual]).
154 | latex_documents = [
155 | ('index', 'open-notify.tex', u'Open Notify API',
156 | u'Nathan Bergey', 'manual'),
157 | ]
158 |
159 | # The name of an image file (relative to this directory) to place at the top of
160 | # the title page.
161 | #latex_logo = None
162 |
163 | # For "manual" documents, if this is true, then toplevel headings are parts,
164 | # not chapters.
165 | #latex_use_parts = False
166 |
167 | # If true, show page references after internal links.
168 | #latex_show_pagerefs = False
169 |
170 | # If true, show URL addresses after external links.
171 | #latex_show_urls = False
172 |
173 | # Documents to append as an appendix to all manuals.
174 | #latex_appendices = []
175 |
176 | # If false, no module index is generated.
177 | #latex_domain_indices = True
178 |
179 |
180 | # -- Options for manual page output --------------------------------------------
181 |
182 | # One entry per manual page. List of tuples
183 | # (source start file, name, description, authors, manual section).
184 | man_pages = [
185 | ('index', 'open-notify', u'Open Notify API',
186 | [u'Nathan Bergey'], 1)
187 | ]
188 |
189 | # If true, show URL addresses after external links.
190 | #man_show_urls = False
191 |
192 |
193 | # -- Options for Texinfo output ------------------------------------------------
194 |
195 | # Grouping the document tree into Texinfo files. List of tuples
196 | # (source start file, target name, title, author,
197 | # dir menu entry, description, category)
198 | texinfo_documents = [
199 | ('index', 'open-notify', u'Open Notify API',
200 | u'Nathan Bergey', 'Open Notify', 'Open Space APIs',
201 | 'Miscellaneous'),
202 | ]
203 |
204 | # Documents to append as an appendix to all manuals.
205 | #texinfo_appendices = []
206 |
207 | # If false, no module index is generated.
208 | #texinfo_domain_indices = True
209 |
210 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
211 | #texinfo_show_urls = 'footnote'
212 |
213 |
214 | # -- Options for Epub output ---------------------------------------------------
215 |
216 | # Bibliographic Dublin Core info.
217 | epub_title = u'Open Notify APIs'
218 | epub_author = u'Nathan Bergey'
219 | epub_publisher = u'Nathan Bergey'
220 | epub_copyright = u'2016, Nathan Bergey'
221 |
222 | # The language of the text. It defaults to the language option
223 | # or en if the language is not set.
224 | #epub_language = ''
225 |
226 | # The scheme of the identifier. Typical schemes are ISBN or URL.
227 | #epub_scheme = ''
228 |
229 | # The unique identifier of the text. This can be a ISBN number
230 | # or the project homepage.
231 | #epub_identifier = ''
232 |
233 | # A unique identification for the text.
234 | #epub_uid = ''
235 |
236 | # A tuple containing the cover image and cover page html template filenames.
237 | #epub_cover = ()
238 |
239 | # HTML files that should be inserted before the pages created by sphinx.
240 | # The format is a list of tuples containing the path and title.
241 | #epub_pre_files = []
242 |
243 | # HTML files shat should be inserted after the pages created by sphinx.
244 | # The format is a list of tuples containing the path and title.
245 | #epub_post_files = []
246 |
247 | # A list of files that should not be packed into the epub file.
248 | #epub_exclude_files = []
249 |
250 | # The depth of the table of contents in toc.ncx.
251 | #epub_tocdepth = 3
252 |
253 | # Allow duplicate toc entries.
254 | #epub_tocdup = True
255 |
--------------------------------------------------------------------------------
/app.py:
--------------------------------------------------------------------------------
1 | import os
2 | from flask import Flask, request, render_template, send_from_directory
3 | import iss
4 | from util import safe_float, json, jsonp
5 |
6 | app = Flask(__name__)
7 |
8 | # APIs:
9 | API_DEFS = [
10 | {
11 | "title": "ISS Location Now",
12 | "link": "/iss-now.json",
13 | "desc": "Current ISS location over Earth (latitude/longitude)",
14 | "doclink": "http://open-notify.org/Open-Notify-API/ISS-Location-Now",
15 | "docname": "ISS-Location-Now"},
16 | {
17 | "title": "ISS Pass Times",
18 | "link": "/iss-pass.json?lat=45.0&lon=-122.3",
19 | "desc": "Predictions when the space station will fly over a particular location",
20 | "doclink": "http://open-notify.org/Open-Notify-API/ISS-Pass-Times",
21 | "docname": "ISS-Pass-Times"},
22 | {
23 | "title": "People in Space Right Now",
24 | "link": "/astros.json",
25 | "desc": "The number of people in space at this moment. List of names when known.",
26 | "doclink": "http://open-notify.org/Open-Notify-API/People-In-Space",
27 | "docname": "People-In-Space"},
28 | ]
29 |
30 | @app.route("/")
31 |
32 | def index():
33 | return render_template('index.html', apis=API_DEFS)
34 |
35 |
36 | @app.route('/favicon.ico')
37 | def favicon():
38 | return send_from_directory(os.path.join(app.root_path, 'static'),
39 | 'favicon.ico', mimetype='image/vnd.microsoft.icon')
40 |
41 |
42 | ################################################################################
43 | # Current ISS Location
44 | ################################################################################
45 | @app.route("/iss-now.json")
46 | @app.route("/iss-now/")
47 | @app.route("/iss-now/v1/")
48 | @jsonp
49 | @json
50 | def iss_now():
51 | """The International Space Station (ISS) is moving at close to 28,000 km/h so its
52 | location changes really fast! Where is it right now?
53 |
54 | This is a simple api to return the current location above the Earth of the ISS.
55 | It returns the current latitude and longitude of the space station with a unix
56 | timestamp for the time the location was valid. This API takes no inputs.
57 |
58 | :status 200: when successful
59 |
60 | :>json str message: Operation status.
61 | :>json int timestamp: Unix timestamp for this location.
62 | :>json obj iss_position: Position on Earth directly below the ISS.
63 | :>json int iss_position.latitude: Latitude
64 | :>json int iss_position.longitude: Longitude
65 |
66 | **Example response**:
67 |
68 | .. sourcecode:: http
69 |
70 | HTTP/1.1 200 OK
71 | Content-Type: application/json
72 |
73 | {
74 | "iss_position": {
75 | "latitude": -19.783929798887073,
76 | "longitude": -72.29753187401747
77 | },
78 | "message": "success",
79 | "timestamp": 1454357342
80 | }
81 |
82 | """
83 | loc = iss.get_location()
84 | return dict({'message': "success"}, **loc), 200
85 |
86 |
87 | ################################################################################
88 | # ISS Orbit Debug
89 | ################################################################################
90 | @app.route("/iss-tle-info.json")
91 | @jsonp
92 | @json
93 | def tle_info():
94 | info = {'tle': iss.get_tle()}
95 | info['tle-time'] = iss.get_tle_time()
96 | info['tle-update'] = iss.get_tle_update()
97 | return dict({'message': "success"}, **info), 200
98 |
99 |
100 | ################################################################################
101 | # ISS Pass Predictions
102 | ################################################################################
103 | @app.route("/iss-pass.json")
104 | @app.route("/iss/")
105 | @app.route("/iss/v1/")
106 | @jsonp
107 | @json
108 | def iss_pass():
109 | """The international space station (ISS) is an orbital outpost circling
110 | high above out heads. Sometimes it's overhead, but when? It depends on your
111 | location. Given a location on Earth (latitude, longitude, and altitude)
112 | this API will compute the next n number of times that the ISS will be
113 | overhead.
114 |
115 | Overhead is defined as 10 degrees in elevation for the observer. The times
116 | are computed in UTC and the length of time that the ISS is above 10 degrees
117 | is in seconds.
118 |
119 | This gives you enough information to compute pass times for up to several
120 | weeks, but beware! times are less and less accurate as you go into the future.
121 | This is because the orbit of the ISS decays unpredictably over time and because
122 | station controllers periodically move the station to higher and lower orbits
123 | for docking, re-boost, and debris avoidance.
124 |
125 | **Overview**
126 |
127 | The API returns a list of upcoming ISS passes for a particular location
128 | formatted as JSON.
129 |
130 | As input it expects a latitude/longitude pair, altitude and how many results
131 | to return. All fields are required.
132 |
133 | As output you get the same inputs back (for checking) and a time stamp when
134 | the API ran in addition to a success or failure message and a list of passes.
135 | Each pass has a duration in seconds and a rise time as a unix time stamp.
136 |
137 | :status 200: when successful
138 | :status 400: if one or more inputs is out of range or invalid
139 |
140 | :query lat: latitude in decimal degrees of the ground station. **required** Range: -90, 90
141 | :query lon: longitude in decimal degress of the ground station. **required** Range: -180, 180
142 | :query alt: altitude in meters of the gronud station. optional. Range: 0, 10,000
143 | :query n: requested number of predictions. default: 5. May return less than requested
144 |
145 | :>json str message: Operation status.
146 | :>json obj request: Parameters used in prediction
147 | :>json list response: List of predicted passes
148 |
149 | **Example Request**:
150 |
151 | .. sourcecode:: http
152 |
153 | GET /iss/v1/?lat=40.027435&lon=-105.251945&alt=1650&n=1 HTTP/1.1
154 | Host: api.open-notify.org
155 | Accept: application/json, text/javascript
156 |
157 |
158 | **Example Response**:
159 |
160 | .. sourcecode:: http
161 |
162 | HTTP/1.1 200 OK
163 | Content-Type: application/json
164 |
165 | {
166 | "message": "success",
167 | "request": {
168 | "altitude": 1650.0,
169 | "datetime": 1454475126,
170 | "latitude": 40.027435,
171 | "longitude": -105.251945,
172 | "passes": 1
173 | },
174 | "response": [
175 | {
176 | "duration": 525,
177 | "risetime": 1454475538
178 | }
179 | ]
180 | }
181 |
182 | """
183 |
184 | # Sanitize inputs
185 | lat = request.args.get('lat', False)
186 | if lat:
187 | lat = safe_float(lat, (-90.0, 90.0))
188 | if not lat:
189 | return {"message": "failure", "reason": "Latitude must be number between -90.0 and 90.0"}, 400
190 | else:
191 | return {"message": "failure", "reason": "Latitude must be specified"}, 400
192 |
193 | lon = request.args.get('lon', False)
194 | if lon:
195 | lon = safe_float(lon, (-180.0, 180.0))
196 | if not lon:
197 | return {"message": "failure", "reason": "Longitue must be number between -180.0 and 180.0"}, 400
198 | else:
199 | return {"message": "failure", "reason": "Longitude must be specified"}, 400
200 |
201 | alt = request.args.get('alt', False)
202 | if alt:
203 | alt = safe_float(alt, (0, 10000))
204 | if not alt:
205 | return {"message": "failure", "reason": "Altitude must be number between 0 and 10,000"}, 400
206 | else:
207 | alt = 100
208 |
209 | n = request.args.get('n', False)
210 | if n:
211 | n = safe_float(n, (1, 100))
212 | if not n:
213 | return {"message": "failure", "reason": "Number of passes must be number between 1 and 100"}, 400
214 | else:
215 | n = 5
216 |
217 | # Calculate data and return
218 | d = iss.get_passes(lon, lat, alt, int(n))
219 | return dict({"message": "success"}, **d), 200
220 |
221 |
222 | ################################################################################
223 | # Current People In Space
224 | ################################################################################
225 | @app.route("/astros.json")
226 | @app.route("/astros/")
227 | @app.route("/astros/v1/")
228 | @jsonp
229 | @json
230 | def astros():
231 | Astros = [
232 | {'name': "Jing Haipeng", 'craft': "Shenzhou 11"},
233 | {'name': "Chen Dong", 'craft': "Shenzhou 11"},
234 | {'name': "Sergey Rizhikov", 'craft': "ISS"},
235 | {'name': "Andrey Borisenko", 'craft': "ISS"},
236 | {'name': "Shane Kimbrough", 'craft': "ISS"},
237 | ]
238 | return {'message': "success", 'number': len(Astros), 'people': Astros}, 200
239 |
240 |
241 | if __name__ == "__main__":
242 | app.debug = True
243 | app.run()
244 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 |
3 |
GNU GENERAL PUBLIC LICENSE
4 | Version 3, 29 June 2007
5 |
6 | Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
7 | Everyone is permitted to copy and distribute verbatim copies
8 | of this license document, but changing it is not allowed.
9 |
10 | Preamble
11 |
12 | The GNU General Public License is a free, copyleft license for
13 | software and other kinds of works.
14 |
15 | The licenses for most software and other practical works are designed
16 | to take away your freedom to share and change the works. By contrast,
17 | the GNU General Public License is intended to guarantee your freedom to
18 | share and change all versions of a program--to make sure it remains free
19 | software for all its users. We, the Free Software Foundation, use the
20 | GNU General Public License for most of our software; it applies also to
21 | any other work released this way by its authors. You can apply it to
22 | your programs, too.
23 |
24 | When we speak of free software, we are referring to freedom, not
25 | price. Our General Public Licenses are designed to make sure that you
26 | have the freedom to distribute copies of free software (and charge for
27 | them if you wish), that you receive source code or can get it if you
28 | want it, that you can change the software or use pieces of it in new
29 | free programs, and that you know you can do these things.
30 |
31 | To protect your rights, we need to prevent others from denying you
32 | these rights or asking you to surrender the rights. Therefore, you have
33 | certain responsibilities if you distribute copies of the software, or if
34 | you modify it: responsibilities to respect the freedom of others.
35 |
36 | For example, if you distribute copies of such a program, whether
37 | gratis or for a fee, you must pass on to the recipients the same
38 | freedoms that you received. You must make sure that they, too, receive
39 | or can get the source code. And you must show them these terms so they
40 | know their rights.
41 |
42 | Developers that use the GNU GPL protect your rights with two steps:
43 | (1) assert copyright on the software, and (2) offer you this License
44 | giving you legal permission to copy, distribute and/or modify it.
45 |
46 | For the developers' and authors' protection, the GPL clearly explains
47 | that there is no warranty for this free software. For both users' and
48 | authors' sake, the GPL requires that modified versions be marked as
49 | changed, so that their problems will not be attributed erroneously to
50 | authors of previous versions.
51 |
52 | Some devices are designed to deny users access to install or run
53 | modified versions of the software inside them, although the manufacturer
54 | can do so. This is fundamentally incompatible with the aim of
55 | protecting users' freedom to change the software. The systematic
56 | pattern of such abuse occurs in the area of products for individuals to
57 | use, which is precisely where it is most unacceptable. Therefore, we
58 | have designed this version of the GPL to prohibit the practice for those
59 | products. If such problems arise substantially in other domains, we
60 | stand ready to extend this provision to those domains in future versions
61 | of the GPL, as needed to protect the freedom of users.
62 |
63 | Finally, every program is threatened constantly by software patents.
64 | States should not allow patents to restrict development and use of
65 | software on general-purpose computers, but in those that do, we wish to
66 | avoid the special danger that patents applied to a free program could
67 | make it effectively proprietary. To prevent this, the GPL assures that
68 | patents cannot be used to render the program non-free.
69 |
70 | The precise terms and conditions for copying, distribution and
71 | modification follow.
72 |
73 | TERMS AND CONDITIONS
74 |
75 | 0. Definitions.
76 |
77 | "This License" refers to version 3 of the GNU General Public License.
78 |
79 | "Copyright" also means copyright-like laws that apply to other kinds of
80 | works, such as semiconductor masks.
81 |
82 | "The Program" refers to any copyrightable work licensed under this
83 | License. Each licensee is addressed as "you". "Licensees" and
84 | "recipients" may be individuals or organizations.
85 |
86 | To "modify" a work means to copy from or adapt all or part of the work
87 | in a fashion requiring copyright permission, other than the making of an
88 | exact copy. The resulting work is called a "modified version" of the
89 | earlier work or a work "based on" the earlier work.
90 |
91 | A "covered work" means either the unmodified Program or a work based
92 | on the Program.
93 |
94 | To "propagate" a work means to do anything with it that, without
95 | permission, would make you directly or secondarily liable for
96 | infringement under applicable copyright law, except executing it on a
97 | computer or modifying a private copy. Propagation includes copying,
98 | distribution (with or without modification), making available to the
99 | public, and in some countries other activities as well.
100 |
101 | To "convey" a work means any kind of propagation that enables other
102 | parties to make or receive copies. Mere interaction with a user through
103 | a computer network, with no transfer of a copy, is not conveying.
104 |
105 | An interactive user interface displays "Appropriate Legal Notices"
106 | to the extent that it includes a convenient and prominently visible
107 | feature that (1) displays an appropriate copyright notice, and (2)
108 | tells the user that there is no warranty for the work (except to the
109 | extent that warranties are provided), that licensees may convey the
110 | work under this License, and how to view a copy of this License. If
111 | the interface presents a list of user commands or options, such as a
112 | menu, a prominent item in the list meets this criterion.
113 |
114 | 1. Source Code.
115 |
116 | The "source code" for a work means the preferred form of the work
117 | for making modifications to it. "Object code" means any non-source
118 | form of a work.
119 |
120 | A "Standard Interface" means an interface that either is an official
121 | standard defined by a recognized standards body, or, in the case of
122 | interfaces specified for a particular programming language, one that
123 | is widely used among developers working in that language.
124 |
125 | The "System Libraries" of an executable work include anything, other
126 | than the work as a whole, that (a) is included in the normal form of
127 | packaging a Major Component, but which is not part of that Major
128 | Component, and (b) serves only to enable use of the work with that
129 | Major Component, or to implement a Standard Interface for which an
130 | implementation is available to the public in source code form. A
131 | "Major Component", in this context, means a major essential component
132 | (kernel, window system, and so on) of the specific operating system
133 | (if any) on which the executable work runs, or a compiler used to
134 | produce the work, or an object code interpreter used to run it.
135 |
136 | The "Corresponding Source" for a work in object code form means all
137 | the source code needed to generate, install, and (for an executable
138 | work) run the object code and to modify the work, including scripts to
139 | control those activities. However, it does not include the work's
140 | System Libraries, or general-purpose tools or generally available free
141 | programs which are used unmodified in performing those activities but
142 | which are not part of the work. For example, Corresponding Source
143 | includes interface definition files associated with source files for
144 | the work, and the source code for shared libraries and dynamically
145 | linked subprograms that the work is specifically designed to require,
146 | such as by intimate data communication or control flow between those
147 | subprograms and other parts of the work.
148 |
149 | The Corresponding Source need not include anything that users
150 | can regenerate automatically from other parts of the Corresponding
151 | Source.
152 |
153 | The Corresponding Source for a work in source code form is that
154 | same work.
155 |
156 | 2. Basic Permissions.
157 |
158 | All rights granted under this License are granted for the term of
159 | copyright on the Program, and are irrevocable provided the stated
160 | conditions are met. This License explicitly affirms your unlimited
161 | permission to run the unmodified Program. The output from running a
162 | covered work is covered by this License only if the output, given its
163 | content, constitutes a covered work. This License acknowledges your
164 | rights of fair use or other equivalent, as provided by copyright law.
165 |
166 | You may make, run and propagate covered works that you do not
167 | convey, without conditions so long as your license otherwise remains
168 | in force. You may convey covered works to others for the sole purpose
169 | of having them make modifications exclusively for you, or provide you
170 | with facilities for running those works, provided that you comply with
171 | the terms of this License in conveying all material for which you do
172 | not control copyright. Those thus making or running the covered works
173 | for you must do so exclusively on your behalf, under your direction
174 | and control, on terms that prohibit them from making any copies of
175 | your copyrighted material outside their relationship with you.
176 |
177 | Conveying under any other circumstances is permitted solely under
178 | the conditions stated below. Sublicensing is not allowed; section 10
179 | makes it unnecessary.
180 |
181 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
182 |
183 | No covered work shall be deemed part of an effective technological
184 | measure under any applicable law fulfilling obligations under article
185 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
186 | similar laws prohibiting or restricting circumvention of such
187 | measures.
188 |
189 | When you convey a covered work, you waive any legal power to forbid
190 | circumvention of technological measures to the extent such circumvention
191 | is effected by exercising rights under this License with respect to
192 | the covered work, and you disclaim any intention to limit operation or
193 | modification of the work as a means of enforcing, against the work's
194 | users, your or third parties' legal rights to forbid circumvention of
195 | technological measures.
196 |
197 | 4. Conveying Verbatim Copies.
198 |
199 | You may convey verbatim copies of the Program's source code as you
200 | receive it, in any medium, provided that you conspicuously and
201 | appropriately publish on each copy an appropriate copyright notice;
202 | keep intact all notices stating that this License and any
203 | non-permissive terms added in accord with section 7 apply to the code;
204 | keep intact all notices of the absence of any warranty; and give all
205 | recipients a copy of this License along with the Program.
206 |
207 | You may charge any price or no price for each copy that you convey,
208 | and you may offer support or warranty protection for a fee.
209 |
210 | 5. Conveying Modified Source Versions.
211 |
212 | You may convey a work based on the Program, or the modifications to
213 | produce it from the Program, in the form of source code under the
214 | terms of section 4, provided that you also meet all of these conditions:
215 |
216 | a) The work must carry prominent notices stating that you modified
217 | it, and giving a relevant date.
218 |
219 | b) The work must carry prominent notices stating that it is
220 | released under this License and any conditions added under section
221 | 7. This requirement modifies the requirement in section 4 to
222 | "keep intact all notices".
223 |
224 | c) You must license the entire work, as a whole, under this
225 | License to anyone who comes into possession of a copy. This
226 | License will therefore apply, along with any applicable section 7
227 | additional terms, to the whole of the work, and all its parts,
228 | regardless of how they are packaged. This License gives no
229 | permission to license the work in any other way, but it does not
230 | invalidate such permission if you have separately received it.
231 |
232 | d) If the work has interactive user interfaces, each must display
233 | Appropriate Legal Notices; however, if the Program has interactive
234 | interfaces that do not display Appropriate Legal Notices, your
235 | work need not make them do so.
236 |
237 | A compilation of a covered work with other separate and independent
238 | works, which are not by their nature extensions of the covered work,
239 | and which are not combined with it such as to form a larger program,
240 | in or on a volume of a storage or distribution medium, is called an
241 | "aggregate" if the compilation and its resulting copyright are not
242 | used to limit the access or legal rights of the compilation's users
243 | beyond what the individual works permit. Inclusion of a covered work
244 | in an aggregate does not cause this License to apply to the other
245 | parts of the aggregate.
246 |
247 | 6. Conveying Non-Source Forms.
248 |
249 | You may convey a covered work in object code form under the terms
250 | of sections 4 and 5, provided that you also convey the
251 | machine-readable Corresponding Source under the terms of this License,
252 | in one of these ways:
253 |
254 | a) Convey the object code in, or embodied in, a physical product
255 | (including a physical distribution medium), accompanied by the
256 | Corresponding Source fixed on a durable physical medium
257 | customarily used for software interchange.
258 |
259 | b) Convey the object code in, or embodied in, a physical product
260 | (including a physical distribution medium), accompanied by a
261 | written offer, valid for at least three years and valid for as
262 | long as you offer spare parts or customer support for that product
263 | model, to give anyone who possesses the object code either (1) a
264 | copy of the Corresponding Source for all the software in the
265 | product that is covered by this License, on a durable physical
266 | medium customarily used for software interchange, for a price no
267 | more than your reasonable cost of physically performing this
268 | conveying of source, or (2) access to copy the
269 | Corresponding Source from a network server at no charge.
270 |
271 | c) Convey individual copies of the object code with a copy of the
272 | written offer to provide the Corresponding Source. This
273 | alternative is allowed only occasionally and noncommercially, and
274 | only if you received the object code with such an offer, in accord
275 | with subsection 6b.
276 |
277 | d) Convey the object code by offering access from a designated
278 | place (gratis or for a charge), and offer equivalent access to the
279 | Corresponding Source in the same way through the same place at no
280 | further charge. You need not require recipients to copy the
281 | Corresponding Source along with the object code. If the place to
282 | copy the object code is a network server, the Corresponding Source
283 | may be on a different server (operated by you or a third party)
284 | that supports equivalent copying facilities, provided you maintain
285 | clear directions next to the object code saying where to find the
286 | Corresponding Source. Regardless of what server hosts the
287 | Corresponding Source, you remain obligated to ensure that it is
288 | available for as long as needed to satisfy these requirements.
289 |
290 | e) Convey the object code using peer-to-peer transmission, provided
291 | you inform other peers where the object code and Corresponding
292 | Source of the work are being offered to the general public at no
293 | charge under subsection 6d.
294 |
295 | A separable portion of the object code, whose source code is excluded
296 | from the Corresponding Source as a System Library, need not be
297 | included in conveying the object code work.
298 |
299 | A "User Product" is either (1) a "consumer product", which means any
300 | tangible personal property which is normally used for personal, family,
301 | or household purposes, or (2) anything designed or sold for incorporation
302 | into a dwelling. In determining whether a product is a consumer product,
303 | doubtful cases shall be resolved in favor of coverage. For a particular
304 | product received by a particular user, "normally used" refers to a
305 | typical or common use of that class of product, regardless of the status
306 | of the particular user or of the way in which the particular user
307 | actually uses, or expects or is expected to use, the product. A product
308 | is a consumer product regardless of whether the product has substantial
309 | commercial, industrial or non-consumer uses, unless such uses represent
310 | the only significant mode of use of the product.
311 |
312 | "Installation Information" for a User Product means any methods,
313 | procedures, authorization keys, or other information required to install
314 | and execute modified versions of a covered work in that User Product from
315 | a modified version of its Corresponding Source. The information must
316 | suffice to ensure that the continued functioning of the modified object
317 | code is in no case prevented or interfered with solely because
318 | modification has been made.
319 |
320 | If you convey an object code work under this section in, or with, or
321 | specifically for use in, a User Product, and the conveying occurs as
322 | part of a transaction in which the right of possession and use of the
323 | User Product is transferred to the recipient in perpetuity or for a
324 | fixed term (regardless of how the transaction is characterized), the
325 | Corresponding Source conveyed under this section must be accompanied
326 | by the Installation Information. But this requirement does not apply
327 | if neither you nor any third party retains the ability to install
328 | modified object code on the User Product (for example, the work has
329 | been installed in ROM).
330 |
331 | The requirement to provide Installation Information does not include a
332 | requirement to continue to provide support service, warranty, or updates
333 | for a work that has been modified or installed by the recipient, or for
334 | the User Product in which it has been modified or installed. Access to a
335 | network may be denied when the modification itself materially and
336 | adversely affects the operation of the network or violates the rules and
337 | protocols for communication across the network.
338 |
339 | Corresponding Source conveyed, and Installation Information provided,
340 | in accord with this section must be in a format that is publicly
341 | documented (and with an implementation available to the public in
342 | source code form), and must require no special password or key for
343 | unpacking, reading or copying.
344 |
345 | 7. Additional Terms.
346 |
347 | "Additional permissions" are terms that supplement the terms of this
348 | License by making exceptions from one or more of its conditions.
349 | Additional permissions that are applicable to the entire Program shall
350 | be treated as though they were included in this License, to the extent
351 | that they are valid under applicable law. If additional permissions
352 | apply only to part of the Program, that part may be used separately
353 | under those permissions, but the entire Program remains governed by
354 | this License without regard to the additional permissions.
355 |
356 | When you convey a copy of a covered work, you may at your option
357 | remove any additional permissions from that copy, or from any part of
358 | it. (Additional permissions may be written to require their own
359 | removal in certain cases when you modify the work.) You may place
360 | additional permissions on material, added by you to a covered work,
361 | for which you have or can give appropriate copyright permission.
362 |
363 | Notwithstanding any other provision of this License, for material you
364 | add to a covered work, you may (if authorized by the copyright holders of
365 | that material) supplement the terms of this License with terms:
366 |
367 | a) Disclaiming warranty or limiting liability differently from the
368 | terms of sections 15 and 16 of this License; or
369 |
370 | b) Requiring preservation of specified reasonable legal notices or
371 | author attributions in that material or in the Appropriate Legal
372 | Notices displayed by works containing it; or
373 |
374 | c) Prohibiting misrepresentation of the origin of that material, or
375 | requiring that modified versions of such material be marked in
376 | reasonable ways as different from the original version; or
377 |
378 | d) Limiting the use for publicity purposes of names of licensors or
379 | authors of the material; or
380 |
381 | e) Declining to grant rights under trademark law for use of some
382 | trade names, trademarks, or service marks; or
383 |
384 | f) Requiring indemnification of licensors and authors of that
385 | material by anyone who conveys the material (or modified versions of
386 | it) with contractual assumptions of liability to the recipient, for
387 | any liability that these contractual assumptions directly impose on
388 | those licensors and authors.
389 |
390 | All other non-permissive additional terms are considered "further
391 | restrictions" within the meaning of section 10. If the Program as you
392 | received it, or any part of it, contains a notice stating that it is
393 | governed by this License along with a term that is a further
394 | restriction, you may remove that term. If a license document contains
395 | a further restriction but permits relicensing or conveying under this
396 | License, you may add to a covered work material governed by the terms
397 | of that license document, provided that the further restriction does
398 | not survive such relicensing or conveying.
399 |
400 | If you add terms to a covered work in accord with this section, you
401 | must place, in the relevant source files, a statement of the
402 | additional terms that apply to those files, or a notice indicating
403 | where to find the applicable terms.
404 |
405 | Additional terms, permissive or non-permissive, may be stated in the
406 | form of a separately written license, or stated as exceptions;
407 | the above requirements apply either way.
408 |
409 | 8. Termination.
410 |
411 | You may not propagate or modify a covered work except as expressly
412 | provided under this License. Any attempt otherwise to propagate or
413 | modify it is void, and will automatically terminate your rights under
414 | this License (including any patent licenses granted under the third
415 | paragraph of section 11).
416 |
417 | However, if you cease all violation of this License, then your
418 | license from a particular copyright holder is reinstated (a)
419 | provisionally, unless and until the copyright holder explicitly and
420 | finally terminates your license, and (b) permanently, if the copyright
421 | holder fails to notify you of the violation by some reasonable means
422 | prior to 60 days after the cessation.
423 |
424 | Moreover, your license from a particular copyright holder is
425 | reinstated permanently if the copyright holder notifies you of the
426 | violation by some reasonable means, this is the first time you have
427 | received notice of violation of this License (for any work) from that
428 | copyright holder, and you cure the violation prior to 30 days after
429 | your receipt of the notice.
430 |
431 | Termination of your rights under this section does not terminate the
432 | licenses of parties who have received copies or rights from you under
433 | this License. If your rights have been terminated and not permanently
434 | reinstated, you do not qualify to receive new licenses for the same
435 | material under section 10.
436 |
437 | 9. Acceptance Not Required for Having Copies.
438 |
439 | You are not required to accept this License in order to receive or
440 | run a copy of the Program. Ancillary propagation of a covered work
441 | occurring solely as a consequence of using peer-to-peer transmission
442 | to receive a copy likewise does not require acceptance. However,
443 | nothing other than this License grants you permission to propagate or
444 | modify any covered work. These actions infringe copyright if you do
445 | not accept this License. Therefore, by modifying or propagating a
446 | covered work, you indicate your acceptance of this License to do so.
447 |
448 | 10. Automatic Licensing of Downstream Recipients.
449 |
450 | Each time you convey a covered work, the recipient automatically
451 | receives a license from the original licensors, to run, modify and
452 | propagate that work, subject to this License. You are not responsible
453 | for enforcing compliance by third parties with this License.
454 |
455 | An "entity transaction" is a transaction transferring control of an
456 | organization, or substantially all assets of one, or subdividing an
457 | organization, or merging organizations. If propagation of a covered
458 | work results from an entity transaction, each party to that
459 | transaction who receives a copy of the work also receives whatever
460 | licenses to the work the party's predecessor in interest had or could
461 | give under the previous paragraph, plus a right to possession of the
462 | Corresponding Source of the work from the predecessor in interest, if
463 | the predecessor has it or can get it with reasonable efforts.
464 |
465 | You may not impose any further restrictions on the exercise of the
466 | rights granted or affirmed under this License. For example, you may
467 | not impose a license fee, royalty, or other charge for exercise of
468 | rights granted under this License, and you may not initiate litigation
469 | (including a cross-claim or counterclaim in a lawsuit) alleging that
470 | any patent claim is infringed by making, using, selling, offering for
471 | sale, or importing the Program or any portion of it.
472 |
473 | 11. Patents.
474 |
475 | A "contributor" is a copyright holder who authorizes use under this
476 | License of the Program or a work on which the Program is based. The
477 | work thus licensed is called the contributor's "contributor version".
478 |
479 | A contributor's "essential patent claims" are all patent claims
480 | owned or controlled by the contributor, whether already acquired or
481 | hereafter acquired, that would be infringed by some manner, permitted
482 | by this License, of making, using, or selling its contributor version,
483 | but do not include claims that would be infringed only as a
484 | consequence of further modification of the contributor version. For
485 | purposes of this definition, "control" includes the right to grant
486 | patent sublicenses in a manner consistent with the requirements of
487 | this License.
488 |
489 | Each contributor grants you a non-exclusive, worldwide, royalty-free
490 | patent license under the contributor's essential patent claims, to
491 | make, use, sell, offer for sale, import and otherwise run, modify and
492 | propagate the contents of its contributor version.
493 |
494 | In the following three paragraphs, a "patent license" is any express
495 | agreement or commitment, however denominated, not to enforce a patent
496 | (such as an express permission to practice a patent or covenant not to
497 | sue for patent infringement). To "grant" such a patent license to a
498 | party means to make such an agreement or commitment not to enforce a
499 | patent against the party.
500 |
501 | If you convey a covered work, knowingly relying on a patent license,
502 | and the Corresponding Source of the work is not available for anyone
503 | to copy, free of charge and under the terms of this License, through a
504 | publicly available network server or other readily accessible means,
505 | then you must either (1) cause the Corresponding Source to be so
506 | available, or (2) arrange to deprive yourself of the benefit of the
507 | patent license for this particular work, or (3) arrange, in a manner
508 | consistent with the requirements of this License, to extend the patent
509 | license to downstream recipients. "Knowingly relying" means you have
510 | actual knowledge that, but for the patent license, your conveying the
511 | covered work in a country, or your recipient's use of the covered work
512 | in a country, would infringe one or more identifiable patents in that
513 | country that you have reason to believe are valid.
514 |
515 | If, pursuant to or in connection with a single transaction or
516 | arrangement, you convey, or propagate by procuring conveyance of, a
517 | covered work, and grant a patent license to some of the parties
518 | receiving the covered work authorizing them to use, propagate, modify
519 | or convey a specific copy of the covered work, then the patent license
520 | you grant is automatically extended to all recipients of the covered
521 | work and works based on it.
522 |
523 | A patent license is "discriminatory" if it does not include within
524 | the scope of its coverage, prohibits the exercise of, or is
525 | conditioned on the non-exercise of one or more of the rights that are
526 | specifically granted under this License. You may not convey a covered
527 | work if you are a party to an arrangement with a third party that is
528 | in the business of distributing software, under which you make payment
529 | to the third party based on the extent of your activity of conveying
530 | the work, and under which the third party grants, to any of the
531 | parties who would receive the covered work from you, a discriminatory
532 | patent license (a) in connection with copies of the covered work
533 | conveyed by you (or copies made from those copies), or (b) primarily
534 | for and in connection with specific products or compilations that
535 | contain the covered work, unless you entered into that arrangement,
536 | or that patent license was granted, prior to 28 March 2007.
537 |
538 | Nothing in this License shall be construed as excluding or limiting
539 | any implied license or other defenses to infringement that may
540 | otherwise be available to you under applicable patent law.
541 |
542 | 12. No Surrender of Others' Freedom.
543 |
544 | If conditions are imposed on you (whether by court order, agreement or
545 | otherwise) that contradict the conditions of this License, they do not
546 | excuse you from the conditions of this License. If you cannot convey a
547 | covered work so as to satisfy simultaneously your obligations under this
548 | License and any other pertinent obligations, then as a consequence you may
549 | not convey it at all. For example, if you agree to terms that obligate you
550 | to collect a royalty for further conveying from those to whom you convey
551 | the Program, the only way you could satisfy both those terms and this
552 | License would be to refrain entirely from conveying the Program.
553 |
554 | 13. Use with the GNU Affero General Public License.
555 |
556 | Notwithstanding any other provision of this License, you have
557 | permission to link or combine any covered work with a work licensed
558 | under version 3 of the GNU Affero General Public License into a single
559 | combined work, and to convey the resulting work. The terms of this
560 | License will continue to apply to the part which is the covered work,
561 | but the special requirements of the GNU Affero General Public License,
562 | section 13, concerning interaction through a network will apply to the
563 | combination as such.
564 |
565 | 14. Revised Versions of this License.
566 |
567 | The Free Software Foundation may publish revised and/or new versions of
568 | the GNU General Public License from time to time. Such new versions will
569 | be similar in spirit to the present version, but may differ in detail to
570 | address new problems or concerns.
571 |
572 | Each version is given a distinguishing version number. If the
573 | Program specifies that a certain numbered version of the GNU General
574 | Public License "or any later version" applies to it, you have the
575 | option of following the terms and conditions either of that numbered
576 | version or of any later version published by the Free Software
577 | Foundation. If the Program does not specify a version number of the
578 | GNU General Public License, you may choose any version ever published
579 | by the Free Software Foundation.
580 |
581 | If the Program specifies that a proxy can decide which future
582 | versions of the GNU General Public License can be used, that proxy's
583 | public statement of acceptance of a version permanently authorizes you
584 | to choose that version for the Program.
585 |
586 | Later license versions may give you additional or different
587 | permissions. However, no additional obligations are imposed on any
588 | author or copyright holder as a result of your choosing to follow a
589 | later version.
590 |
591 | 15. Disclaimer of Warranty.
592 |
593 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
594 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
595 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
596 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
597 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
598 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
599 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
600 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
601 |
602 | 16. Limitation of Liability.
603 |
604 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
605 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
606 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
607 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
608 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
609 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
610 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
611 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
612 | SUCH DAMAGES.
613 |
614 | 17. Interpretation of Sections 15 and 16.
615 |
616 | If the disclaimer of warranty and limitation of liability provided
617 | above cannot be given local legal effect according to their terms,
618 | reviewing courts shall apply local law that most closely approximates
619 | an absolute waiver of all civil liability in connection with the
620 | Program, unless a warranty or assumption of liability accompanies a
621 | copy of the Program in return for a fee.
622 |
623 | END OF TERMS AND CONDITIONS
624 |
625 | How to Apply These Terms to Your New Programs
626 |
627 | If you develop a new program, and you want it to be of the greatest
628 | possible use to the public, the best way to achieve this is to make it
629 | free software which everyone can redistribute and change under these terms.
630 |
631 | To do so, attach the following notices to the program. It is safest
632 | to attach them to the start of each source file to most effectively
633 | state the exclusion of warranty; and each file should have at least
634 | the "copyright" line and a pointer to where the full notice is found.
635 |
636 | <one line to give the program's name and a brief idea of what it does.>
637 | Copyright (C) <year> <name of author>
638 |
639 | This program is free software: you can redistribute it and/or modify
640 | it under the terms of the GNU General Public License as published by
641 | the Free Software Foundation, either version 3 of the License, or
642 | (at your option) any later version.
643 |
644 | This program is distributed in the hope that it will be useful,
645 | but WITHOUT ANY WARRANTY; without even the implied warranty of
646 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
647 | GNU General Public License for more details.
648 |
649 | You should have received a copy of the GNU General Public License
650 | along with this program. If not, see <http://www.gnu.org/licenses/>.
651 |
652 | Also add information on how to contact you by electronic and paper mail.
653 |
654 | If the program does terminal interaction, make it output a short
655 | notice like this when it starts in an interactive mode:
656 |
657 | <program> Copyright (C) <year> <name of author>
658 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
659 | This is free software, and you are welcome to redistribute it
660 | under certain conditions; type `show c' for details.
661 |
662 | The hypothetical commands `show w' and `show c' should show the appropriate
663 | parts of the General Public License. Of course, your program's commands
664 | might be different; for a GUI interface, you would use an "about box".
665 |
666 | You should also get your employer (if you work as a programmer) or school,
667 | if any, to sign a "copyright disclaimer" for the program, if necessary.
668 | For more information on this, and how to apply and follow the GNU GPL, see
669 | <http://www.gnu.org/licenses/>.
670 |
671 | The GNU General Public License does not permit incorporating your program
672 | into proprietary programs. If your program is a subroutine library, you
673 | may consider it more useful to permit linking proprietary applications with
674 | the library. If this is what you want to do, use the GNU Lesser General
675 | Public License instead of this License. But first, please read
676 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
677 |
Window size: 1920 x 1173 Viewport size: 1920 x 1098