Add PyPI configuration

double_pendula/animate_double_pendula.py → animate_double_pendula.py

@@ -12,7 +12,7 @@
 import matplotlib.pyplot as plt
 from matplotlib import animation
 
-from double_pendulum import DoublePendulum
+from double_pendula.double_pendula import DoublePendula
 
 def random_hex() -> str:
     """Return a random hex color i.e. #FFFFFF"""
@@ -43,7 +43,7 @@ def animate(i):
 
 def create_axes(
         fig: "matplotlib.figure.Figure",
-        pendula: List["DoublePendulum"]
+        pendula: List["DoublePendula"]
     ) -> List["matplotlib.axes._subplots.AxesSubplot"]:
     """Create all the individual axes for the double pendula"""
     axes = []
@@ -61,7 +61,7 @@ def create_axes(
     return axes
 
 def _create_individual_axis(
-        longest_double_pendulum: "DoublePendulum",
+        longest_double_pendulum: "DoublePendula",
         fig: "matplotlib.figure.Figure",
         i: int
     ) -> None:
@@ -88,7 +88,7 @@ def _create_individual_axis(
 if __name__ == "__main__":
     # Create the pendula
     fig = plt.figure()
-    pendula = DoublePendulum.create_multiple_double_pendula(num_pendula=10)
+    pendula = DoublePendula.create_multiple_double_pendula(num_pendula=10)
     axes = create_axes(fig=fig, pendula=pendula)
     pendula_axes = list(zip(pendula, axes))
 

bin/pypi

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+#Automate the process of uploading package to PyPI
+
+#Delete older version build directories
+directories=("dist/" "build/" "double-pendula.egg-info/")
+for d in ${directories[@]};
+do
+	if [ -d $d ];
+	then
+		rm -rf $d
+		echo "$d deleted!"
+	fi
+done
+
+# cd docs
+# sphinx-apidoc -o source/ ../spyrograph/ --separate
+# make clean
+# make html
+# cd ..
+
+#Setup package and initiate upload to PyPI
+python3 setup.py sdist bdist_wheel
+twine upload dist/*

double_pendula/double_pendulum.py → double_pendula/double_pendula.py

@@ -8,10 +8,10 @@
 import numpy as np
 from scipy import constants
 
-from pendulum import Pendulum
-from equations import derivative, solve_ode
+from .pendulum import Pendulum
+from .equations import derivative, solve_ode
 
-class DoublePendulum:
+class DoublePendula:
     """Model of a double pendulum"""
     # pylint: disable=too-many-instance-attributes
     tmax = 15.0

setup.py

@@ -0,0 +1,25 @@
+"""Setup script for publishing package to PyPI"""
+
+import setuptools
+
+with open("README.md", "r", encoding='UTF-8') as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="double-pendula",
+    version="0.1.4",
+    author="Chris Greening",
+    author_email="chris@christophergreening.com",
+    description="Library for animating double pendula in Python",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/chris-greening/double-pendula",
+    packages=setuptools.find_packages(),
+    install_requires=["numpy", "pandas", "scipy"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.7",
+)