Skip to content

Commit 7c647e7

Browse files
author
Chaim-Leib Halbert
committed
allowed simplified import statements (from tincan import RemoteLRS) for external modules. Added package-level docstring.
1 parent 3994ece commit 7c647e7

File tree

1 file changed

+53
-1
lines changed

1 file changed

+53
-1
lines changed

tincan/__init__.py

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,53 @@
1-
# empty for now
1+
"""
2+
Client library for communicating with an LRS (Learning Record Store)
3+
implementing Tin Can API version 1.0.0 or 1.0.1.
4+
5+
Web site: <https://github.com/RusticiSoftware/TinCanPython>
6+
7+
For more info about the Tin Can API, see <http://tincanapi.com/>.
8+
"""
9+
10+
# These imports are for convenience to external modules only.
11+
# Internal tincan modules should continue to use explicit imports,
12+
# since this file will not have run yet.
13+
#
14+
# For example, from the outside, you can say:
15+
# from tincan import RemoteLRS, LRSResponse
16+
#
17+
# but inside the tincan package, we have to use:
18+
# from tincan.remote_lrs import RemoteLRS
19+
# from tincan.lrs_response import LRSResponse
20+
21+
from about import About
22+
from activity import Activity
23+
from activity_definition import ActivityDefinition
24+
from activity_list import ActivityList
25+
from agent import Agent
26+
from agent_account import AgentAccount
27+
from agent_list import AgentList
28+
from attachment import Attachment
29+
from attachment_list import AttachmentList
30+
from base import Base
31+
from context import Context
32+
from context_activities import ContextActivities
33+
from extensions import Extensions
34+
from group import Group
35+
from http_request import HTTPRequest
36+
from interaction_component import InteractionComponent
37+
from interaction_component_list import InteractionComponentList
38+
from language_map import LanguageMap
39+
from lrs_response import LRSResponse
40+
from remote_lrs import RemoteLRS
41+
from result import Result
42+
from score import Score
43+
from serializable_base import SerializableBase
44+
from statement import Statement
45+
from statement_base import StatementBase
46+
from statement_list import StatementList
47+
from statement_ref import StatementRef
48+
from statement_targetable import StatementTargetable
49+
from statements_result import StatementsResult
50+
from substatement import SubStatement
51+
from typed_list import TypedList
52+
from verb import Verb
53+
from version import Version

0 commit comments

Comments
 (0)