From 0d287084f7494e26e959774c016bd0b0cca83fef Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 09:52:04 -0400 Subject: [PATCH 01/17] REFACTOR: moved objects into separate subpackages --- spyrograph/epitroichoid/__init__.py | 0 spyrograph/{ => epitroichoid}/cardioid.py | 0 spyrograph/{ => epitroichoid}/epicycloid.py | 0 spyrograph/{ => epitroichoid}/epitrochoid.py | 0 spyrograph/{ => epitroichoid}/nephroid.py | 0 spyrograph/{ => epitroichoid}/ranuncloid.py | 0 spyrograph/hypotrochoid/__init__.py | 0 spyrograph/{ => hypotrochoid}/astroid.py | 0 spyrograph/{ => hypotrochoid}/deltoid.py | 0 spyrograph/{ => hypotrochoid}/ellipse.py | 0 spyrograph/{ => hypotrochoid}/hypocycloid.py | 0 spyrograph/{ => hypotrochoid}/hypotrochoid.py | 0 spyrograph/{ => hypotrochoid}/tusi_couple.py | 0 13 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 spyrograph/epitroichoid/__init__.py rename spyrograph/{ => epitroichoid}/cardioid.py (100%) rename spyrograph/{ => epitroichoid}/epicycloid.py (100%) rename spyrograph/{ => epitroichoid}/epitrochoid.py (100%) rename spyrograph/{ => epitroichoid}/nephroid.py (100%) rename spyrograph/{ => epitroichoid}/ranuncloid.py (100%) create mode 100644 spyrograph/hypotrochoid/__init__.py rename spyrograph/{ => hypotrochoid}/astroid.py (100%) rename spyrograph/{ => hypotrochoid}/deltoid.py (100%) rename spyrograph/{ => hypotrochoid}/ellipse.py (100%) rename spyrograph/{ => hypotrochoid}/hypocycloid.py (100%) rename spyrograph/{ => hypotrochoid}/hypotrochoid.py (100%) rename spyrograph/{ => hypotrochoid}/tusi_couple.py (100%) diff --git a/spyrograph/epitroichoid/__init__.py b/spyrograph/epitroichoid/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/spyrograph/cardioid.py b/spyrograph/epitroichoid/cardioid.py similarity index 100% rename from spyrograph/cardioid.py rename to spyrograph/epitroichoid/cardioid.py diff --git a/spyrograph/epicycloid.py b/spyrograph/epitroichoid/epicycloid.py similarity index 100% rename from spyrograph/epicycloid.py rename to spyrograph/epitroichoid/epicycloid.py diff --git a/spyrograph/epitrochoid.py b/spyrograph/epitroichoid/epitrochoid.py similarity index 100% rename from spyrograph/epitrochoid.py rename to spyrograph/epitroichoid/epitrochoid.py diff --git a/spyrograph/nephroid.py b/spyrograph/epitroichoid/nephroid.py similarity index 100% rename from spyrograph/nephroid.py rename to spyrograph/epitroichoid/nephroid.py diff --git a/spyrograph/ranuncloid.py b/spyrograph/epitroichoid/ranuncloid.py similarity index 100% rename from spyrograph/ranuncloid.py rename to spyrograph/epitroichoid/ranuncloid.py diff --git a/spyrograph/hypotrochoid/__init__.py b/spyrograph/hypotrochoid/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/spyrograph/astroid.py b/spyrograph/hypotrochoid/astroid.py similarity index 100% rename from spyrograph/astroid.py rename to spyrograph/hypotrochoid/astroid.py diff --git a/spyrograph/deltoid.py b/spyrograph/hypotrochoid/deltoid.py similarity index 100% rename from spyrograph/deltoid.py rename to spyrograph/hypotrochoid/deltoid.py diff --git a/spyrograph/ellipse.py b/spyrograph/hypotrochoid/ellipse.py similarity index 100% rename from spyrograph/ellipse.py rename to spyrograph/hypotrochoid/ellipse.py diff --git a/spyrograph/hypocycloid.py b/spyrograph/hypotrochoid/hypocycloid.py similarity index 100% rename from spyrograph/hypocycloid.py rename to spyrograph/hypotrochoid/hypocycloid.py diff --git a/spyrograph/hypotrochoid.py b/spyrograph/hypotrochoid/hypotrochoid.py similarity index 100% rename from spyrograph/hypotrochoid.py rename to spyrograph/hypotrochoid/hypotrochoid.py diff --git a/spyrograph/tusi_couple.py b/spyrograph/hypotrochoid/tusi_couple.py similarity index 100% rename from spyrograph/tusi_couple.py rename to spyrograph/hypotrochoid/tusi_couple.py From 634bc4e7899aef8b7458fb26c731447b3720f704 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 09:55:31 -0400 Subject: [PATCH 02/17] FIX: fixing Pylint workflow --- .github/workflows/pylint.yaml | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/.github/workflows/pylint.yaml b/.github/workflows/pylint.yaml index a20b1c9..cd2b6c4 100644 --- a/.github/workflows/pylint.yaml +++ b/.github/workflows/pylint.yaml @@ -18,14 +18,6 @@ jobs: run: | python -m pip install --upgrade pip pip install pylint - - name: Get Python changed files - id: changed-py-files - uses: tj-actions/changed-files@v23 - with: - files: | - *.py - **/*.py - name: Analysing the code with pylint run: | - if: steps.changed-py-files.outputs.any_changed == 'true' - run: pylint ${{ steps.changed-py-files.outputs.all_changed_files }} \ No newline at end of file + pylint $(git ls-files '*.py') \ No newline at end of file From 20d56531bc0b3898632fec734e33df412d51805b Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 09:57:49 -0400 Subject: [PATCH 03/17] FIX: fixed import path resolution for hypo objects --- spyrograph/hypotrochoid/astroid.py | 2 +- spyrograph/hypotrochoid/deltoid.py | 2 +- spyrograph/hypotrochoid/ellipse.py | 2 +- spyrograph/hypotrochoid/hypocycloid.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spyrograph/hypotrochoid/astroid.py b/spyrograph/hypotrochoid/astroid.py index 8f6eb71..06d9f54 100644 --- a/spyrograph/hypotrochoid/astroid.py +++ b/spyrograph/hypotrochoid/astroid.py @@ -5,7 +5,7 @@ from numbers import Number from typing import List -from spyrograph.hypocycloid import Hypocycloid +from spyrograph.hypotrochoid.hypocycloid import Hypocycloid class Astroid(Hypocycloid): """Model of an astroid which is a special case of a hypocycloid where the diff --git a/spyrograph/hypotrochoid/deltoid.py b/spyrograph/hypotrochoid/deltoid.py index d45dd4c..b4a2ceb 100644 --- a/spyrograph/hypotrochoid/deltoid.py +++ b/spyrograph/hypotrochoid/deltoid.py @@ -5,7 +5,7 @@ from numbers import Number from typing import List -from spyrograph.hypocycloid import Hypocycloid +from spyrograph.hypotrochoid.hypocycloid import Hypocycloid class Deltoid(Hypocycloid): """Model of a deltoid which is a special case of a hypocycloid where the diff --git a/spyrograph/hypotrochoid/ellipse.py b/spyrograph/hypotrochoid/ellipse.py index e6ea6e0..9a16786 100644 --- a/spyrograph/hypotrochoid/ellipse.py +++ b/spyrograph/hypotrochoid/ellipse.py @@ -6,7 +6,7 @@ from numbers import Number from typing import List -from spyrograph.hypotrochoid import Hypotrochoid +from spyrograph.hypotrochoid.hypotrochoid import Hypotrochoid class Ellipse(Hypotrochoid): """Model of an ellipse which is a special case of a hypotrochoid where the diff --git a/spyrograph/hypotrochoid/hypocycloid.py b/spyrograph/hypotrochoid/hypocycloid.py index 688aac2..7601dc7 100644 --- a/spyrograph/hypotrochoid/hypocycloid.py +++ b/spyrograph/hypotrochoid/hypocycloid.py @@ -5,7 +5,7 @@ from typing import List from numbers import Number -from spyrograph.hypotrochoid import Hypotrochoid +from spyrograph.hypotrochoid.hypotrochoid import Hypotrochoid class Hypocycloid(Hypotrochoid): """Model of a hypocycloid which is a special case of a hypotrochoid where From 4edeefa1f971086520487e7416f42bf89ba506ab Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 09:59:36 -0400 Subject: [PATCH 04/17] ADD: added imports of hypotrochoid objects to hypotrochoid __init___.py --- spyrograph/__init__.py | 7 ------- spyrograph/hypotrochoid/__init__.py | 6 ++++++ 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/spyrograph/__init__.py b/spyrograph/__init__.py index 923c45b..eaa5f73 100644 --- a/spyrograph/__init__.py +++ b/spyrograph/__init__.py @@ -1,13 +1,6 @@ """Import top-level API""" - -from spyrograph.hypotrochoid import Hypotrochoid from spyrograph.epitrochoid import Epitrochoid -from spyrograph.hypocycloid import Hypocycloid from spyrograph.epicycloid import Epicycloid -from spyrograph.deltoid import Deltoid -from spyrograph.astroid import Astroid -from spyrograph.ellipse import Ellipse -from spyrograph.tusi_couple import TusiCouple from spyrograph.cardioid import Cardioid from spyrograph.nephroid import Nephroid from spyrograph.ranuncloid import Ranuncloid diff --git a/spyrograph/hypotrochoid/__init__.py b/spyrograph/hypotrochoid/__init__.py index e69de29..97992c5 100644 --- a/spyrograph/hypotrochoid/__init__.py +++ b/spyrograph/hypotrochoid/__init__.py @@ -0,0 +1,6 @@ +from spyrograph.hypotrochoid.hypotrochoid import Hypotrochoid +from spyrograph.hypotrochoid.hypocycloid import Hypocycloid +from spyrograph.hypotrochoid.deltoid import Deltoid +from spyrograph.hypotrochoid.astroid import Astroid +from spyrograph.hypotrochoid.ellipse import Ellipse +from spyrograph.hypotrochoid.tusi_couple import TusiCouple From d783cc9907e560d82674dba6c5ee14eeda6478b8 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:01:01 -0400 Subject: [PATCH 05/17] FIX: fixed path to objects to point to epitrochoid subpackage --- spyrograph/epitroichoid/cardioid.py | 2 +- spyrograph/epitroichoid/epicycloid.py | 2 +- spyrograph/epitroichoid/nephroid.py | 2 +- spyrograph/epitroichoid/ranuncloid.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spyrograph/epitroichoid/cardioid.py b/spyrograph/epitroichoid/cardioid.py index 13e8fbd..5353587 100644 --- a/spyrograph/epitroichoid/cardioid.py +++ b/spyrograph/epitroichoid/cardioid.py @@ -5,7 +5,7 @@ from typing import List from numbers import Number -from spyrograph.epicycloid import Epicycloid +from spyrograph.epitrochoid.epicycloid import Epicycloid class Cardioid(Epicycloid): """Model of a cardioid which is a special case of an epicycloid where the diff --git a/spyrograph/epitroichoid/epicycloid.py b/spyrograph/epitroichoid/epicycloid.py index fd62cd9..1de3532 100644 --- a/spyrograph/epitroichoid/epicycloid.py +++ b/spyrograph/epitroichoid/epicycloid.py @@ -5,7 +5,7 @@ from typing import List from numbers import Number -from spyrograph.epitrochoid import Epitrochoid +from spyrograph.epitrochoid.epitrochoid import Epitrochoid class Epicycloid(Epitrochoid): """Model of a epicycloid which is a special case of a epitrochoid where the diff --git a/spyrograph/epitroichoid/nephroid.py b/spyrograph/epitroichoid/nephroid.py index 8a8af14..945da4f 100644 --- a/spyrograph/epitroichoid/nephroid.py +++ b/spyrograph/epitroichoid/nephroid.py @@ -5,7 +5,7 @@ from typing import List from numbers import Number -from spyrograph.epicycloid import Epicycloid +from spyrograph.epitrochoid.epicycloid import Epicycloid class Nephroid(Epicycloid): """Model of a nephroid which is a special case of an epicycloid where the diff --git a/spyrograph/epitroichoid/ranuncloid.py b/spyrograph/epitroichoid/ranuncloid.py index 8ff8bd8..9dd5361 100644 --- a/spyrograph/epitroichoid/ranuncloid.py +++ b/spyrograph/epitroichoid/ranuncloid.py @@ -5,7 +5,7 @@ from typing import List from numbers import Number -from spyrograph.epicycloid import Epicycloid +from spyrograph.epitrochoid.epicycloid import Epicycloid class Ranuncloid(Epicycloid): """Model of a ranuncloid which is a special case of an epicycloid where the From e58cea6236485edfce014d80d34add13dece82ca Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:02:00 -0400 Subject: [PATCH 06/17] ADD: added references to epitrochoid objects --- spyrograph/__init__.py | 7 +------ spyrograph/epitroichoid/__init__.py | 5 +++++ 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/spyrograph/__init__.py b/spyrograph/__init__.py index eaa5f73..4c91eee 100644 --- a/spyrograph/__init__.py +++ b/spyrograph/__init__.py @@ -1,6 +1 @@ -"""Import top-level API""" -from spyrograph.epitrochoid import Epitrochoid -from spyrograph.epicycloid import Epicycloid -from spyrograph.cardioid import Cardioid -from spyrograph.nephroid import Nephroid -from spyrograph.ranuncloid import Ranuncloid +"""Import top-level API""" \ No newline at end of file diff --git a/spyrograph/epitroichoid/__init__.py b/spyrograph/epitroichoid/__init__.py index e69de29..6467168 100644 --- a/spyrograph/epitroichoid/__init__.py +++ b/spyrograph/epitroichoid/__init__.py @@ -0,0 +1,5 @@ +from spyrograph.epitrochoid.epitrochoid import Epitrochoid +from spyrograph.epitrochoid.epicycloid import Epicycloid +from spyrograph.epitrochoid.cardioid import Cardioid +from spyrograph.epitrochoid.nephroid import Nephroid +from spyrograph.epitrochoid.ranuncloid import Ranuncloid \ No newline at end of file From f22ce225de38e134290e7b21872d2d08dbb301b9 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:03:02 -0400 Subject: [PATCH 07/17] ADD: added setuptools.find_packages() to packages arg in setup --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 53ead86..cad4ea9 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ long_description=long_description, long_description_content_type="text/markdown", url="https://github.com/chris-greening/spyrograph", - packages=[], + packages=setuptools.find_packages(), install_requires=[], classifiers=[ "Programming Language :: Python :: 3", From f357d4a876b79d6996502e631b4c9443e4652b66 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:06:03 -0400 Subject: [PATCH 08/17] ADD: imported the subpackages into toplevel API --- spyrograph/__init__.py | 4 +++- spyrograph/{epitroichoid => epitrochoid}/__init__.py | 0 spyrograph/{epitroichoid => epitrochoid}/cardioid.py | 0 spyrograph/{epitroichoid => epitrochoid}/epicycloid.py | 0 spyrograph/{epitroichoid => epitrochoid}/epitrochoid.py | 0 spyrograph/{epitroichoid => epitrochoid}/nephroid.py | 0 spyrograph/{epitroichoid => epitrochoid}/ranuncloid.py | 0 7 files changed, 3 insertions(+), 1 deletion(-) rename spyrograph/{epitroichoid => epitrochoid}/__init__.py (100%) rename spyrograph/{epitroichoid => epitrochoid}/cardioid.py (100%) rename spyrograph/{epitroichoid => epitrochoid}/epicycloid.py (100%) rename spyrograph/{epitroichoid => epitrochoid}/epitrochoid.py (100%) rename spyrograph/{epitroichoid => epitrochoid}/nephroid.py (100%) rename spyrograph/{epitroichoid => epitrochoid}/ranuncloid.py (100%) diff --git a/spyrograph/__init__.py b/spyrograph/__init__.py index 4c91eee..84cead4 100644 --- a/spyrograph/__init__.py +++ b/spyrograph/__init__.py @@ -1 +1,3 @@ -"""Import top-level API""" \ No newline at end of file +"""Import top-level API""" +from spyrograph.hypotrochoid import * +from spyrograph.epitrochoid import * \ No newline at end of file diff --git a/spyrograph/epitroichoid/__init__.py b/spyrograph/epitrochoid/__init__.py similarity index 100% rename from spyrograph/epitroichoid/__init__.py rename to spyrograph/epitrochoid/__init__.py diff --git a/spyrograph/epitroichoid/cardioid.py b/spyrograph/epitrochoid/cardioid.py similarity index 100% rename from spyrograph/epitroichoid/cardioid.py rename to spyrograph/epitrochoid/cardioid.py diff --git a/spyrograph/epitroichoid/epicycloid.py b/spyrograph/epitrochoid/epicycloid.py similarity index 100% rename from spyrograph/epitroichoid/epicycloid.py rename to spyrograph/epitrochoid/epicycloid.py diff --git a/spyrograph/epitroichoid/epitrochoid.py b/spyrograph/epitrochoid/epitrochoid.py similarity index 100% rename from spyrograph/epitroichoid/epitrochoid.py rename to spyrograph/epitrochoid/epitrochoid.py diff --git a/spyrograph/epitroichoid/nephroid.py b/spyrograph/epitrochoid/nephroid.py similarity index 100% rename from spyrograph/epitroichoid/nephroid.py rename to spyrograph/epitrochoid/nephroid.py diff --git a/spyrograph/epitroichoid/ranuncloid.py b/spyrograph/epitrochoid/ranuncloid.py similarity index 100% rename from spyrograph/epitroichoid/ranuncloid.py rename to spyrograph/epitrochoid/ranuncloid.py From 00b73ed4007e6c453b5a0770de6a45f3148f3b97 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:08:40 -0400 Subject: [PATCH 09/17] MODIFY: made changes to make pylint happy --- docs/conf.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2de3f56..1d79b10 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,4 @@ -# Configuration file for the Sphinx documentation builder. +"""Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: @@ -9,7 +9,9 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -# +""" +# pylint: disable=invalid-name,redefined-builtin + import os import sys sys.path.insert(0, os.path.abspath('..')) @@ -65,4 +67,4 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -autodoc_default_flags = ['members', 'inherited-members'] \ No newline at end of file +autodoc_default_flags = ['members', 'inherited-members'] From 7e0df03bfcc7b94fb8704cb58ab6bc5a045a1f67 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:10:00 -0400 Subject: [PATCH 10/17] ADD: added encoding argument to open --- setup.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index cad4ea9..79572f0 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,8 @@ +"""Setup script for publishing package to PyPI""" + import setuptools -with open("README.md", "r") as fh: +with open("README.md", "r", encoding='UTF-8') as fh: long_description = fh.read() setuptools.setup( @@ -20,4 +22,4 @@ "Operating System :: OS Independent", ], python_requires=">=3.7", -) \ No newline at end of file +) From aad5cb205aece41ffd6b46a227c118701e2fd09d Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:10:25 -0400 Subject: [PATCH 11/17] ADD: added newline to make pylint happy --- spyrograph/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spyrograph/__init__.py b/spyrograph/__init__.py index 84cead4..a92c716 100644 --- a/spyrograph/__init__.py +++ b/spyrograph/__init__.py @@ -1,3 +1,3 @@ """Import top-level API""" from spyrograph.hypotrochoid import * -from spyrograph.epitrochoid import * \ No newline at end of file +from spyrograph.epitrochoid import * From 0da8fb81f179ab1c430df3856f794a3d4b82899b Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:10:50 -0400 Subject: [PATCH 12/17] ADD: added newline to __init__ to make pylint happy --- spyrograph/epitrochoid/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spyrograph/epitrochoid/__init__.py b/spyrograph/epitrochoid/__init__.py index 6467168..c3d8fec 100644 --- a/spyrograph/epitrochoid/__init__.py +++ b/spyrograph/epitrochoid/__init__.py @@ -2,4 +2,4 @@ from spyrograph.epitrochoid.epicycloid import Epicycloid from spyrograph.epitrochoid.cardioid import Cardioid from spyrograph.epitrochoid.nephroid import Nephroid -from spyrograph.epitrochoid.ranuncloid import Ranuncloid \ No newline at end of file +from spyrograph.epitrochoid.ranuncloid import Ranuncloid From 19186dab248e793d0b76c11c6150ca6026793acc Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:23:42 -0400 Subject: [PATCH 13/17] FIX: removed cyclic import to hypotrochoid.__init__ and specificed abs path to hypotrochoid --- spyrograph/hypotrochoid/tusi_couple.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spyrograph/hypotrochoid/tusi_couple.py b/spyrograph/hypotrochoid/tusi_couple.py index a62f50e..ee254a3 100644 --- a/spyrograph/hypotrochoid/tusi_couple.py +++ b/spyrograph/hypotrochoid/tusi_couple.py @@ -5,7 +5,7 @@ from numbers import Number from typing import List -from spyrograph.hypotrochoid import Hypotrochoid +from spyrograph.hypotrochoid.hypotrochoid import Hypotrochoid class TusiCouple(Hypotrochoid): """Model of a Tusi couple which is a special case of a hypotrochoid where From 1bd622cd5d903e90aa5f9001cab42b38e6130348 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:25:32 -0400 Subject: [PATCH 14/17] DOCS: added module level docstrings for the __init__ files in subpackages --- spyrograph/epitrochoid/__init__.py | 2 ++ spyrograph/hypotrochoid/__init__.py | 2 ++ 2 files changed, 4 insertions(+) diff --git a/spyrograph/epitrochoid/__init__.py b/spyrograph/epitrochoid/__init__.py index c3d8fec..e187036 100644 --- a/spyrograph/epitrochoid/__init__.py +++ b/spyrograph/epitrochoid/__init__.py @@ -1,3 +1,5 @@ +"""Import all epitrochoids into toplevel API for easy importing""" + from spyrograph.epitrochoid.epitrochoid import Epitrochoid from spyrograph.epitrochoid.epicycloid import Epicycloid from spyrograph.epitrochoid.cardioid import Cardioid diff --git a/spyrograph/hypotrochoid/__init__.py b/spyrograph/hypotrochoid/__init__.py index 97992c5..2f2fe9d 100644 --- a/spyrograph/hypotrochoid/__init__.py +++ b/spyrograph/hypotrochoid/__init__.py @@ -1,3 +1,5 @@ +"""Import all epitrochoids into toplevel API for easy importing""" + from spyrograph.hypotrochoid.hypotrochoid import Hypotrochoid from spyrograph.hypotrochoid.hypocycloid import Hypocycloid from spyrograph.hypotrochoid.deltoid import Deltoid From e819ce2f2c1dcc105e1279df7e1d497e9ef742c6 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:27:31 -0400 Subject: [PATCH 15/17] MODIFY: incr patch version number to 0.11.3 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 79572f0..24f433b 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ setuptools.setup( name="spyrograph", - version="0.11.2", + version="0.11.3", author="Chris Greening", author_email="chris@christophergreening.com", description="Library for drawing spirographs in Python", From ee271e68c2029dc84f93fb983f14e7e96cf563dd Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:32:02 -0400 Subject: [PATCH 16/17] ADD: added references to new locations of these objects --- docs/index.rst | 22 +++++++++---------- .../spyrograph.epitrochoid.cardioid.rst | 8 +++++++ .../spyrograph.epitrochoid.epicycloid.rst | 8 +++++++ .../spyrograph.epitrochoid.epitrochoid.rst | 8 +++++++ .../spyrograph.epitrochoid.nephroid.rst | 8 +++++++ .../spyrograph.epitrochoid.ranuncloid.rst | 8 +++++++ .../spyrograph.hypotrochoid.astroid.rst | 8 +++++++ .../spyrograph.hypotrochoid.deltoid.rst | 8 +++++++ .../spyrograph.hypotrochoid.ellipse.rst | 8 +++++++ .../spyrograph.hypotrochoid.hypocycloid.rst | 8 +++++++ .../spyrograph.hypotrochoid.hypotrochoid.rst | 8 +++++++ .../spyrograph.hypotrochoid.tusi_couple.rst | 8 +++++++ 12 files changed, 99 insertions(+), 11 deletions(-) create mode 100644 docs/source/spyrograph.epitrochoid.cardioid.rst create mode 100644 docs/source/spyrograph.epitrochoid.epicycloid.rst create mode 100644 docs/source/spyrograph.epitrochoid.epitrochoid.rst create mode 100644 docs/source/spyrograph.epitrochoid.nephroid.rst create mode 100644 docs/source/spyrograph.epitrochoid.ranuncloid.rst create mode 100644 docs/source/spyrograph.hypotrochoid.astroid.rst create mode 100644 docs/source/spyrograph.hypotrochoid.deltoid.rst create mode 100644 docs/source/spyrograph.hypotrochoid.ellipse.rst create mode 100644 docs/source/spyrograph.hypotrochoid.hypocycloid.rst create mode 100644 docs/source/spyrograph.hypotrochoid.hypotrochoid.rst create mode 100644 docs/source/spyrograph.hypotrochoid.tusi_couple.rst diff --git a/docs/index.rst b/docs/index.rst index d948e77..2f983eb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,20 +17,20 @@ spyrograph is a lightweight Python package that provides an expressive and flexi Hypotrochoid ------------ -* :doc:`Hypotrochoid ` -* :doc:`Hypocycloid ` -* :doc:`Ellipse ` -* :doc:`Tusi couple ` -* :doc:`Deltoid ` -* :doc:`Astroid ` +* :doc:`Hypotrochoid ` +* :doc:`Hypocycloid ` +* :doc:`Ellipse ` +* :doc:`Tusi couple ` +* :doc:`Deltoid ` +* :doc:`Astroid ` Epitrochoid ----------- -* :doc:`Epitrochoid ` -* :doc:`Epicycloid ` -* :doc:`Cardioid ` -* :doc:`Nephroid ` -* :doc:`Ranuncloid ` +* :doc:`Epitrochoid ` +* :doc:`Epicycloid ` +* :doc:`Cardioid ` +* :doc:`Nephroid ` +* :doc:`Ranuncloid ` Indices and tables ================== diff --git a/docs/source/spyrograph.epitrochoid.cardioid.rst b/docs/source/spyrograph.epitrochoid.cardioid.rst new file mode 100644 index 0000000..0f13747 --- /dev/null +++ b/docs/source/spyrograph.epitrochoid.cardioid.rst @@ -0,0 +1,8 @@ +spyrograph.epitrochoid.cardioid module +====================================== + +.. automodule:: spyrograph.epitrochoid.cardioid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.epitrochoid.epicycloid.rst b/docs/source/spyrograph.epitrochoid.epicycloid.rst new file mode 100644 index 0000000..d65b97c --- /dev/null +++ b/docs/source/spyrograph.epitrochoid.epicycloid.rst @@ -0,0 +1,8 @@ +spyrograph.epitrochoid.epicycloid module +======================================== + +.. automodule:: spyrograph.epitrochoid.epicycloid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.epitrochoid.epitrochoid.rst b/docs/source/spyrograph.epitrochoid.epitrochoid.rst new file mode 100644 index 0000000..bc1dbcb --- /dev/null +++ b/docs/source/spyrograph.epitrochoid.epitrochoid.rst @@ -0,0 +1,8 @@ +spyrograph.epitrochoid.epitrochoid module +========================================= + +.. automodule:: spyrograph.epitrochoid.epitrochoid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.epitrochoid.nephroid.rst b/docs/source/spyrograph.epitrochoid.nephroid.rst new file mode 100644 index 0000000..6dd416e --- /dev/null +++ b/docs/source/spyrograph.epitrochoid.nephroid.rst @@ -0,0 +1,8 @@ +spyrograph.epitrochoid.nephroid module +====================================== + +.. automodule:: spyrograph.epitrochoid.nephroid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.epitrochoid.ranuncloid.rst b/docs/source/spyrograph.epitrochoid.ranuncloid.rst new file mode 100644 index 0000000..b1f542d --- /dev/null +++ b/docs/source/spyrograph.epitrochoid.ranuncloid.rst @@ -0,0 +1,8 @@ +spyrograph.epitrochoid.ranuncloid module +======================================== + +.. automodule:: spyrograph.epitrochoid.ranuncloid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.hypotrochoid.astroid.rst b/docs/source/spyrograph.hypotrochoid.astroid.rst new file mode 100644 index 0000000..aae178a --- /dev/null +++ b/docs/source/spyrograph.hypotrochoid.astroid.rst @@ -0,0 +1,8 @@ +spyrograph.hypotrochoid.astroid module +====================================== + +.. automodule:: spyrograph.hypotrochoid.astroid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.hypotrochoid.deltoid.rst b/docs/source/spyrograph.hypotrochoid.deltoid.rst new file mode 100644 index 0000000..ab1ab08 --- /dev/null +++ b/docs/source/spyrograph.hypotrochoid.deltoid.rst @@ -0,0 +1,8 @@ +spyrograph.hypotrochoid.deltoid module +====================================== + +.. automodule:: spyrograph.hypotrochoid.deltoid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.hypotrochoid.ellipse.rst b/docs/source/spyrograph.hypotrochoid.ellipse.rst new file mode 100644 index 0000000..1ad288d --- /dev/null +++ b/docs/source/spyrograph.hypotrochoid.ellipse.rst @@ -0,0 +1,8 @@ +spyrograph.hypotrochoid.ellipse module +====================================== + +.. automodule:: spyrograph.hypotrochoid.ellipse + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.hypotrochoid.hypocycloid.rst b/docs/source/spyrograph.hypotrochoid.hypocycloid.rst new file mode 100644 index 0000000..dedef6d --- /dev/null +++ b/docs/source/spyrograph.hypotrochoid.hypocycloid.rst @@ -0,0 +1,8 @@ +spyrograph.hypotrochoid.hypocycloid module +========================================== + +.. automodule:: spyrograph.hypotrochoid.hypocycloid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.hypotrochoid.hypotrochoid.rst b/docs/source/spyrograph.hypotrochoid.hypotrochoid.rst new file mode 100644 index 0000000..af5a616 --- /dev/null +++ b/docs/source/spyrograph.hypotrochoid.hypotrochoid.rst @@ -0,0 +1,8 @@ +spyrograph.hypotrochoid.hypotrochoid module +=========================================== + +.. automodule:: spyrograph.hypotrochoid.hypotrochoid + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file diff --git a/docs/source/spyrograph.hypotrochoid.tusi_couple.rst b/docs/source/spyrograph.hypotrochoid.tusi_couple.rst new file mode 100644 index 0000000..e2d108f --- /dev/null +++ b/docs/source/spyrograph.hypotrochoid.tusi_couple.rst @@ -0,0 +1,8 @@ +spyrograph.hypotrochoid.tusi\_couple module +=========================================== + +.. automodule:: spyrograph.hypotrochoid.tusi_couple + :members: + :undoc-members: + :show-inheritance: + :inherited-members: \ No newline at end of file From 656f76ab4a790200eb12d5922ae9b0f84bd49df3 Mon Sep 17 00:00:00 2001 From: Christopher Greening Date: Sat, 18 Mar 2023 10:33:38 -0400 Subject: [PATCH 17/17] FIX: fixed epicycloid to epitrochoid for docs ref --- docs/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 2f983eb..db37fa5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,11 +26,11 @@ Hypotrochoid Epitrochoid ----------- -* :doc:`Epitrochoid ` -* :doc:`Epicycloid ` -* :doc:`Cardioid ` -* :doc:`Nephroid ` -* :doc:`Ranuncloid ` +* :doc:`Epitrochoid ` +* :doc:`Epicycloid ` +* :doc:`Cardioid ` +* :doc:`Nephroid ` +* :doc:`Ranuncloid ` Indices and tables ==================