Renamed repository for community bundle

cognitivegears · Mar 30, 2021 · 853b807 · 853b807
1 parent 4d5f5f5
commit 853b807
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 54 deletions.
diff --git a/README.rst b/README.rst
@@ -2,8 +2,8 @@ Introduction
 ============
 
 
-.. image:: https://readthedocs.org/projects/circuitpython-uschedule/badge/?version=latest
-    :target: https://circuitpython-uschedule.readthedocs.io/
+.. image:: https://readthedocs.org/projects/circuitpython-schedule/badge/?version=latest
+    :target: https://circuitpython-schedule.readthedocs.io/
     :alt: Documentation Status
 
 
@@ -12,8 +12,8 @@ Introduction
     :alt: Discord
 
 
-.. image:: https://github.com/cognitivegears/CircuitPython_uschedule/workflows/Build%20CI/badge.svg
-    :target: https://github.com/cognitivegears/CircuitPython_uschedule/actions
+.. image:: https://github.com/cognitivegears/CircuitPython_Schedule/workflows/Build%20CI/badge.svg
+    :target: https://github.com/cognitivegears/CircuitPython_Schedule/actions
     :alt: Build Status
 
 
@@ -46,18 +46,18 @@ or individual libraries can be installed using
 
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-uschedule/>`_.
+PyPI <https://pypi.org/project/circuitpython-schedule/>`_.
 To install for current user:
 
 .. code-block:: shell
 
-    pip3 install adafruit-circuitpython-uschedule
+    pip3 install circuitpython-schedule
 
 To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 
-    sudo pip3 install adafruit-circuitpython-uschedule
+    sudo pip3 install circuitpython-schedule
 
 To install in a virtual environment in your current project:
 
@@ -66,7 +66,7 @@ To install in a virtual environment in your current project:
     mkdir project-name && cd project-name
     python3 -m venv .env
     source .env/bin/activate
-    pip3 install adafruit-circuitpython-uschedule
+    pip3 install circuitpython-schedule
 
 
 
@@ -76,7 +76,7 @@ Usage Example
 .. code-block:: python
 
     import time
-    import uschedule as schedule
+    import circuitpython-schedule as schedule
 
     def greet():
         print("Hello, world!")
@@ -94,14 +94,14 @@ Contributing
 ============
 
 Contributions are welcome! Please read our `Code of Conduct
-<https://github.com/cognitivegears/CircuitPython_uschedule/blob/main/CODE_OF_CONDUCT.md>`_
+<https://github.com/cognitivegears/CircuitPython_Schedule/blob/main/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
 Documentation
 =============
 
 Read the `module documentation`__.
 
-.. _moduledocumentation: https://circuitpython-uschedule.readthedocs.io/
+.. _moduledocumentation: https://circuitpython-schedule.readthedocs.io/
 
 __ moduledocumentation_
diff --git a/uschedule.py → circuitpython_schedule.py b/uschedule.py → circuitpython_schedule.py
@@ -29,7 +29,7 @@
     - Tested on Python 3.6, 3.7, 3.8, 3.9
 
 Usage:
-    >>> import uschedule as schedule
+    >>> import circuitpython_schedule as schedule
     >>> import time
 
     >>> def job():
@@ -311,7 +311,7 @@ def second(self):
             IntervalError: Thrown if the interval is not 1
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError("Use seconds instead of second")
@@ -322,7 +322,7 @@ def seconds(self):
         """Specify the type of an interval as seconds.
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         self.unit = "seconds"
         return self
@@ -336,7 +336,7 @@ def minute(self):
             IntervalError: Thrown if the interval is not 1
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError("Use minutes instead of minute")
@@ -347,7 +347,7 @@ def minutes(self):
         """Specify the type of an interval as minutes.
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         self.unit = "minutes"
         return self
@@ -361,7 +361,7 @@ def hour(self):
             IntervalError: Thrown if the interval is not 1
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError("Use hours instead of hour")
@@ -372,7 +372,7 @@ def hours(self):
         """Specify the type of an interval as hours.
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         self.unit = "hours"
         return self
@@ -386,7 +386,7 @@ def day(self):
             IntervalError: Thrown if the interval is not 1
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError("Use days instead of day")
@@ -397,7 +397,7 @@ def days(self):
         """Specify the type of an interval as days.
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         self.unit = "days"
         return self
@@ -411,7 +411,7 @@ def week(self):
             IntervalError: Thrown if the interval is not 1
 
         Returns:
-            uschedule: self
+            circuitpython_schedule: self
         """
         if self.interval != 1:
             raise IntervalError("Use weeks instead of week")
@@ -422,7 +422,7 @@ def weeks(self):
         """Specify the type of an interval as weeks
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         self.unit = "weeks"
         return self
@@ -436,7 +436,7 @@ def monday(self):
             IntervalError: Thrown if interval is not weekly
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError(
@@ -456,7 +456,7 @@ def tuesday(self):
             IntervalError: Thrown if interval is not weekly
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError(
@@ -476,7 +476,7 @@ def wednesday(self):
             IntervalError: Thrown if interval is not weekly
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError(
@@ -496,7 +496,7 @@ def thursday(self):
             IntervalError: Thrown if interval is not weekly
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError(
@@ -516,7 +516,7 @@ def friday(self):
             IntervalError: Thrown if interval is not weekly
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError(
@@ -536,7 +536,7 @@ def saturday(self):
             IntervalError: Thrown if interval is not weekly
 
         Returns:
-            uschedule: Returns self
+            circuitpython_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError(
@@ -556,7 +556,7 @@ def sunday(self):
             IntervalError: Thrown if interval is not weekly
 
         Returns:
-            uschedule: Returns self
+            circuitpyhon_schedule: Returns self
         """
         if self.interval != 1:
             raise IntervalError(
@@ -700,7 +700,7 @@ def until(self, until_time):
                 datetime.datetime.now(), until_time
             )
         elif isinstance(until_time, str):
-            raise ScheduleValueError("String format not supported in uschedule")
+            raise ScheduleValueError("String format not supported")
         else:
             raise TypeError(
                 "until() takes a string, datetime.datetime, datetime.timedelta, "

diff --git a/docs/api.rst b/docs/api.rst
@@ -4,5 +4,5 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
-.. automodule:: uschedule
+.. automodule:: circuitpython_schedule
    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,7 +45,7 @@
 master_doc = "index"
 
 # General information about the project.
-project = " CircuitPython uschedule Library"
+project = " CircuitPython schedule Library"
 copyright = "2021 Nathan Byrd"
 author = "Nathan Byrd"
 
@@ -127,7 +127,7 @@
 html_favicon = "_static/favicon.ico"
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "CircuitPython_UscheduleLibrarydoc"
+htmlhelp_basename = "CircuitPython_ScheduleLibrarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -148,8 +148,8 @@
 latex_documents = [
     (
         master_doc,
-        "CircuitPython_uscheduleLibrary.tex",
-        "CircuitPython uschedule Library Documentation",
+        "CircuitPython_ScheduleLibrary.tex",
+        "CircuitPython Schedule Library Documentation",
         author,
         "manual",
     ),
@@ -162,8 +162,8 @@
 man_pages = [
     (
         master_doc,
-        "CircuitPython_uscheduleLibrary",
-        "CircuitPython uschedule Library Documentation",
+        "CircuitPython_ScheduleLibrary",
+        "CircuitPython Schedule Library Documentation",
         [author],
         1,
     ),
@@ -177,11 +177,11 @@
 texinfo_documents = [
     (
         master_doc,
-        "CircuitPython_uscheduleLibrary",
-        "CircuitPython uschedule Library Documentation",
+        "CircuitPython_ScheduleLibrary",
+        "CircuitPython Schedule Library Documentation",
         author,
-        "CircuitPython_uscheduleLibrary",
-        "One line description of project.",
+        "CircuitPython_ScheduleLibrary",
+        "Schedule library implementation for CircuitPython",
         "Miscellaneous",
     ),
 ]
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -3,8 +3,8 @@ Simple test
 
 Ensure your device works with this simple test.
 
-.. literalinclude:: ../examples/uschedule_simpletest.py
-    :caption: examples/uschedule_simpletest.py
+.. literalinclude:: ../examples/circuitpython_schedule_simpletest.py
+    :caption: examples/circuitpython_schedule_simpletest.py
     :linenos:
 
 
@@ -13,8 +13,8 @@ Additional utilities
 
 Additional utilities that are available
 
-.. literalinclude:: ../examples/uschedule_util.py
-    :caption: examples/uschedule_util.py
+.. literalinclude:: ../examples/circuitpython_schedule_util.py
+    :caption: examples/circuitpython_schedule_util.py
     :linenos:
 
 
@@ -24,6 +24,6 @@ Real Time Clock
 This module works great in combination with a Real Time Clock (RTC), if one is
 available on your device.  For example:
 
-.. literalinclude:: ../examples/uschedule_rtc.py
-    :caption: examples/uschedule_rtc.py
+.. literalinclude:: ../examples/circuitpython_schedule_rtc.py
+    :caption: examples/circuitpython_schedule_rtc.py
     :linenos:
diff --git a/docs/index.rst b/docs/index.rst
@@ -30,7 +30,7 @@ Table of Contents
 .. toctree::
     :caption: Other Links
 
-    Download <https://github.com/cognitivegears/CircuitPython_uschedule/releases/latest>
+    Download <https://github.com/cognitivegears/CircuitPython_Schedule/releases/latest>
     CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
     CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
     Discord Chat <https://adafru.it/discord>

diff --git a/examples/uschedule_rtc.py → examples/circuitpython_schedule_rtc.py b/examples/uschedule_rtc.py → examples/circuitpython_schedule_rtc.py
@@ -8,7 +8,7 @@
 import busio
 import board
 import adafruit_pcf8523
-import uschedule as schedule
+import circuitpython_schedule as schedule
 
 
 def greet():

diff --git a/examples/uschedule_simpletest.py → ...ples/circuitpython_schedule_simpletest.py b/examples/uschedule_simpletest.py → ...ples/circuitpython_schedule_simpletest.py
@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: MIT
 
 import time
-import uschedule as schedule
+import circuitpython_schedule as schedule
 
 
 def greet():

diff --git a/examples/uschedule_util.py → examples/circuitpython_schedule_util.py b/examples/uschedule_util.py → examples/circuitpython_schedule_util.py
@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: MIT
 
 import time
-import uschedule as schedule
+import circuitpython_schedule as schedule
 
 
 def greet():