FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

update docs · python-webuntis/python-webuntis@ce1abba · GitHub

Commit ce1abba

Browse files
committed
update docs
1 parent e283a79 commit ce1abba

5 files changed

Lines changed: 32 additions & 12 deletions

File tree

‎LICENSE‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
Copyright (c) 2013-2016, Markus Unterwaditzer
2+
Copyright (c) 2018, August Hörandl
23

34
Some rights reserved.
45

‎docs/changelog.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22
Changelog
33
=========
44

5+
* work in progress:
6+
7+
* Dropped Python 2.6 support, added Python up to 3.7
8+
9+
* Code completion support for all objects
10+
11+
* Added str() and reps() for all objects for easier debugging
12+
13+
* Added new/missing API calls:
14+
15+
* last_import_time
16+
* substitutions
17+
* timegrid_units
18+
* students
19+
* exam_types
20+
* exams
21+
* timetable_with_absences
22+
* class_reg_events
23+
24+
* Code cleanup
25+
526
* 0.1.9:
627

728
* Add requests as a dependency and use it instead of urllib. Big security

‎docs/session.rst‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,12 @@ Things you can do with the API
3030
.. automethod:: subjects
3131
.. automethod:: teachers
3232
.. automethod:: statusdata
33-
.. automethod:: lastImportTime
33+
.. automethod:: last_import_time
3434
.. automethod:: substitutions
35-
.. automethod:: timegridUnits
35+
.. automethod:: timegrid_units
3636
.. automethod:: students
37+
.. automethod:: exam_types
38+
.. automethod:: exams
39+
.. automethod:: timetable_with_absences
40+
.. automethod:: class_reg_events
3741

‎setup.py‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,6 @@
1111

1212
dependencies = ['requests']
1313

14-
if version_info < (2, 6):
15-
dependencies.append('simplejson')
16-
17-
if version_info < (2, 7):
18-
dependencies.append('ordereddict')
19-
2014
setup(
2115
name='webuntis',
2216
version='0.1.9',

‎webuntis/objects.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ def lesson_types(self):
594594
"""A list of :py:class:`ColorInfo` objects, containing
595595
information about all lesson types defined
596596
597-
:rtype: List[ColorInfo]
597+
:rtype: `list` [ColorInfo]
598598
"""
599599
return [
600600
ColorInfo(parent=self, data=data)
@@ -606,7 +606,7 @@ def period_codes(self):
606606
"""A list of :py:class:`ColorInfo` objects, containing
607607
information about all period codes defined
608608
609-
:rtype: List[ColorInfo]
609+
:rtype: `list` [ColorInfo]
610610
"""
611611
return [
612612
ColorInfo(parent=self, data=data)
@@ -773,7 +773,7 @@ class ExamObject(Result):
773773

774774
# classes list of classes
775775
# teachers list of teachers
776-
# students lsit of students
776+
# students list of students
777777
# subject
778778

779779
@lazyproperty
@@ -814,7 +814,7 @@ def teachers(self):
814814

815815
@lazyproperty
816816
def subject(self):
817-
"""A :py:class:`SubjectOject` with the subject which are topic of
817+
"""A :py:class:`SubjectObject` with the subject which are topic of
818818
this period."""
819819
return self._session.subjects(from_cache=True).filter(id=self._data[u'subject'])[0]
820820

0 commit comments

Comments
 (0)

Back | FazBrowse Home | New Git URL