Merge pull request #1 from karam-mustafa/main

v1.0.3

Author: karam-mustafa

CHANGELOG.md

@@ -0,0 +1,3 @@
+v1.0.0
+---------
+* First release

README.md

@@ -1,2 +1,55 @@
-# python-oak-leaf-drawer
+<p align="center">
+  <img src="https://github.com/karam-mustafa/python-oak-leaf-drawer/blob/main/assets/logo.png" />
+</p>
+
+Python oak leaf drawer
+----------------------
 Python package making you able to draw OAK Leaf depending on an angle.
+
+##### Dependency
+The first step is using composer to install the package and automatically update your composer.json file, you can do this by running:
+
+```shell
+
+pip install python-oak-leaf-drawer
+
+```
+
+Usage
+-----------
+```
+from python_oak_leaf_drawer.oak import drawPattern
+
+# The first parameter is the rotation angle.
+# The second parameter is the title.
+drawPattern(15 , "syrian open source 😎, oak package")
+
+```
+Examples:
+----------
+```
+drawPattern(15 , "syrian open source 😎, oak package")
+```
+![example1](assets/example1.png)
+```
+drawPattern(30 , "syrian open source 😎, oak package")
+```
+![example2](assets/example2.png)
+```
+drawPattern(45 , "syrian open source 😎, oak package")
+```
+![example3](assets/example3.png)
+
+Changelog
+---------
+Please see the [CHANGELOG](https://github.com/syrian-open-source/python-oak-leaf-drawer/blob/master/CHANGELOG.md) for more information about what has changed or updated or added recently.
+
+Security
+--------
+If you discover any security related issues, please email them first to "[email protected]", 
+if we do not fix it within a short period of time please open a new issue describing your problem. 
+
+Credits
+-------
+* [Karam Mustafa](https://www.linkedin.com/in/karam2mustafa/)
+* [All contributors](https://github.com/syrian-open-source/python-oak-leaf-drawer/graphs/contributors)

assets/example1.png

@@ -0,0 +1 @@
+from python_oak_leaf_drawer.oak import drawPattern

assets/example2.png

@@ -0,0 +1,99 @@
+import math
+import matplotlib.pyplot as plt
+
+
+# declare the functions a,b,c,d,e,f,g
+def resolveA(teta):
+    return 0.01 * (math.cos(teta) ** 9) * (math.cos(5.0 * teta) ** 10)
+
+
+def resolveB(teta):
+    return 0.25 * math.sin(2 * teta)
+
+
+def resolveC(teta):
+    return 1 - 0.5 * math.sin(10 * teta) ** 2
+
+
+def resolveD(teta):
+    return 1 - (math.cos(teta) * math.cos(3 * teta)) ** 8
+
+
+def resolveE(teta):
+    return math.sin(teta)
+
+
+def resolveF(teta):
+    return 0.2 * math.sin(10 * teta) ** 2
+
+
+def resolveG(teta):
+    return 0.5 + math.sin(2 * teta) ** 2
+
+
+
+xRotatedList = []
+yRotatedList = []
+xList = []
+yList = []
+
+def OakLeafX(teta):
+    return resolveA(teta) + (resolveB(teta) * resolveC(teta) * resolveD(teta))
+
+
+def OakLeafY(teta):
+    return resolveE(teta) * (1 - (resolveF(teta) * resolveG(teta)))
+
+
+def generateOakLeaf():
+    for i in range(1, 180):
+        xList.append(OakLeafX(math.radians(i)))
+    for i in range(1, 180):
+        yList.append(OakLeafY(math.radians(i)))
+
+    return xList, yList
+
+
+def plot(xList, yList, title):
+    plt.plot(xList, yList)
+    plt.title(title)
+    plt.show()
+
+
+xList, yList = generateOakLeaf()
+# plot(xList, yList, "One Oak Leaf")
+
+xRotatedList = []
+yRotatedList = []
+
+
+def generateRotatedList(xList, yList, angle):
+    for i in range(1, 180):
+        xRotatedList.append((yList[i] * math.sin(math.radians(angle))) + (xList[i] * math.cos(math.radians(angle))))
+        yRotatedList.append((yList[i] * math.cos(math.radians(angle))) - (xList[i] * math.sin(math.radians(angle))))
+
+    return xRotatedList, yRotatedList
+
+xRotatedList = []
+yRotatedList = []
+
+
+def generateOakLeafPattern(rotationAngle):
+    xPatternList = []
+    yPatternList = []
+
+    xList, yList = generateOakLeaf()
+    if rotationAngle <= 0:
+        count = 1
+    else:
+        count = 360 / rotationAngle
+
+    for j in range(0, math.ceil(count)):
+        xPatternList += generateRotatedList(xList, yList, (rotationAngle * j))[0]
+        yPatternList += generateRotatedList(xList, yList, (rotationAngle * j))[1]
+
+    return xRotatedList, yRotatedList
+
+
+def drawPattern(rotationAngle, text):
+    plot(generateOakLeafPattern(rotationAngle)[0], generateOakLeafPattern(rotationAngle)[1], text)

assets/example3.png

@@ -7,18 +7,18 @@
 with codecs.open(os.path.join(here, "README.md"), encoding="utf-8") as fh:
     long_description = "\n" + fh.read()
 
-VERSION = '1.0.0'
+VERSION = '1.0.3'
 DESCRIPTION = 'Python module depending on matplotlib to draw oak leaf.'
 LONG_DESCRIPTION = 'Python module depending on matplotlib and angle to draw oak leaf wih specific title.'
 
 setup(
-    name="python-oak-leaf-drawer",
-    version="1.0.0",
+    name="python_oak_leaf_drawer",
+    version=VERSION,
     author="Karam Mustafa",
     author_email="[email protected]",
-    description="Python module depending on matplotlib to draw oak leaf.",
-    long_description_content_type="Python module depending on matplotlib and angle to draw oak leaf wih specific title.",
-    long_description="Python module depending on matplotlib and angle to draw oak leaf wih specific title.",
+    description=DESCRIPTION,
+    long_description_content_type="text/markdown",
+    long_description=LONG_DESCRIPTION,
     packages=find_packages(),
     install_requires=['matplotlib'],
     keywords=['python', 'oak', 'oak-leaf', 'python-packages', 'matplotib'],