Skip to content

Commit bc98eb6

Browse files
committed
Update Strings, Docstrings, and Copyright Notices
Update .gitignore to include direnv exclusion. Update some docstrings. Update copyright notices.
1 parent f5af07b commit bc98eb6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+250
-170
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# `local` working directory
1+
# Local Files
2+
.envrc
23
local/
34

45

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 Cisco Systems, Inc.
3+
Copyright (c) 2016-2018 Cisco and/or its affiliates.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ Please use the issues_ log.
172172
#. Submit a `pull request`_.
173173

174174

175-
*Copyright (c) 2016 Cisco Systems, Inc.*
175+
*Copyright (c) 2016-2018 Cisco and/or its affiliates.*
176+
176177

177178
.. _Introduction: http://ciscosparkapi.readthedocs.io/en/latest/user/intro.html
178179
.. _pagination: https://developer.ciscospark.com/pagination.html

ciscosparkapi/__init__.py

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@
1212
from builtins import *
1313
from past.builtins import basestring
1414

15+
16+
__author__ = "Chris Lunsford"
17+
__author_email__ = "[email protected]"
18+
__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
19+
__license__ = "MIT"
20+
__all__ = [
21+
"CiscoSparkAPI", "ciscosparkapiException", "SparkApiError",
22+
"SparkRateLimitError", "Person", "Room", "Membership", "Message", "Team",
23+
"TeamMembership", "Webhook", "WebhookEvent", "Organization", "License",
24+
"Role", "AccessToken"
25+
]
26+
27+
1528
import logging
1629
import os
1730

@@ -54,18 +67,6 @@
5467
from .utils import check_type
5568

5669

57-
__author__ = "Chris Lunsford"
58-
__author_email__ = "[email protected]"
59-
__copyright__ = "Copyright (c) 2016 Cisco Systems, Inc."
60-
__license__ = "MIT"
61-
__all__ = [
62-
"CiscoSparkAPI", "ciscosparkapiException", "SparkApiError",
63-
"SparkRateLimitError", "Person", "Room", "Membership", "Message", "Team",
64-
"TeamMembership", "Webhook", "WebhookEvent", "Organization", "License",
65-
"Role", "AccessToken"
66-
]
67-
68-
6970
# Versioneer version control
7071
from ._version import get_versions
7172
__version__ = get_versions()['version']

ciscosparkapi/api/access_tokens.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@
2222
from future import standard_library
2323
standard_library.install_aliases()
2424

25+
26+
__author__ = "Chris Lunsford"
27+
__author_email__ = "[email protected]"
28+
__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
29+
__license__ = "MIT"
30+
31+
2532
import urllib.parse
2633

2734
import requests
@@ -37,12 +44,6 @@
3744
)
3845

3946

40-
__author__ = "Chris Lunsford"
41-
__author_email__ = "[email protected]"
42-
__copyright__ = "Copyright (c) 2016 Cisco Systems, Inc."
43-
__license__ = "MIT"
44-
45-
4647
API_ENDPOINT = "access_token"
4748

4849

ciscosparkapi/api/licenses.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@
1919
from builtins import *
2020
from past.builtins import basestring
2121

22+
23+
__author__ = "Chris Lunsford"
24+
__author_email__ = "[email protected]"
25+
__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
26+
__license__ = "MIT"
27+
28+
2229
from ..generator_containers import generator_container
2330
from ..restsession import RestSession
2431
from ..sparkdata import SparkData
@@ -28,12 +35,6 @@
2835
)
2936

3037

31-
__author__ = "Chris Lunsford"
32-
__author_email__ = "[email protected]"
33-
__copyright__ = "Copyright (c) 2016 Cisco Systems, Inc."
34-
__license__ = "MIT"
35-
36-
3738
class License(SparkData):
3839
"""Model a Spark License JSON object as a native Python object."""
3940

ciscosparkapi/api/memberships.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@
2020
from builtins import *
2121
from past.builtins import basestring
2222

23+
24+
__author__ = "Chris Lunsford"
25+
__author_email__ = "[email protected]"
26+
__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
27+
__license__ = "MIT"
28+
29+
2330
from ..generator_containers import generator_container
2431
from ..restsession import RestSession
2532
from ..sparkdata import SparkData
@@ -29,12 +36,6 @@
2936
)
3037

3138

32-
__author__ = "Chris Lunsford"
33-
__author_email__ = "[email protected]"
34-
__copyright__ = "Copyright (c) 2016 Cisco Systems, Inc."
35-
__license__ = "MIT"
36-
37-
3839
class Membership(SparkData):
3940
"""Model a Spark 'membership' JSON object as a native Python object."""
4041

ciscosparkapi/api/messages.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@
1919
from builtins import *
2020
from past.builtins import basestring
2121

22+
23+
__author__ = "Chris Lunsford"
24+
__author_email__ = "[email protected]"
25+
__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
26+
__license__ = "MIT"
27+
28+
2229
from requests_toolbelt import MultipartEncoder
2330

2431
from ..generator_containers import generator_container
@@ -33,12 +40,6 @@
3340
)
3441

3542

36-
__author__ = "Chris Lunsford"
37-
__author_email__ = "[email protected]"
38-
__copyright__ = "Copyright (c) 2016 Cisco Systems, Inc."
39-
__license__ = "MIT"
40-
41-
4243
class Message(SparkData):
4344
"""Model a Spark 'message' JSON object as a native Python object."""
4445

ciscosparkapi/api/organizations.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@
2020
from builtins import *
2121
from past.builtins import basestring
2222

23+
24+
__author__ = "Chris Lunsford"
25+
__author_email__ = "[email protected]"
26+
__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
27+
__license__ = "MIT"
28+
29+
2330
from ..generator_containers import generator_container
2431
from ..restsession import RestSession
2532
from ..sparkdata import SparkData
@@ -29,12 +36,6 @@
2936
)
3037

3138

32-
__author__ = "Chris Lunsford"
33-
__author_email__ = "[email protected]"
34-
__copyright__ = "Copyright (c) 2016 Cisco Systems, Inc."
35-
__license__ = "MIT"
36-
37-
3839
class Organization(SparkData):
3940
"""Model a Spark Organization JSON object as a native Python object."""
4041

ciscosparkapi/api/people.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@
1919
from builtins import *
2020
from past.builtins import basestring
2121

22+
23+
__author__ = "Chris Lunsford"
24+
__author_email__ = "[email protected]"
25+
__copyright__ = "Copyright (c) 2016-2018 Cisco and/or its affiliates."
26+
__license__ = "MIT"
27+
28+
2229
from ..generator_containers import generator_container
2330
from ..restsession import RestSession
2431
from ..sparkdata import SparkData
@@ -28,12 +35,6 @@
2835
)
2936

3037

31-
__author__ = "Chris Lunsford"
32-
__author_email__ = "[email protected]"
33-
__copyright__ = "Copyright (c) 2016 Cisco Systems, Inc."
34-
__license__ = "MIT"
35-
36-
3738
class Person(SparkData):
3839
"""Model a Spark person JSON object as a native Python object."""
3940

0 commit comments

Comments
 (0)