setup for PyPi package export

j0ono0 · Mar 29, 2021 · 915afa6 · 915afa6
1 parent 3908e47
commit 915afa6
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -16,11 +16,13 @@ Please visit [pinout.readthedocs.io](https://pinout.readthedocs.io) for the late
 
 ### Install
 
-Using a virtual environment is recommended; Start by installing the *pinout* package. Either clone this repo and pip install it or install directly from github...
+Using a virtual environment is recommended; Start by installing the *pinout* package. Either clone this repo and pip install it or install from PyPi:
 ```
-pip install git+https://github.com/j0ono0/pinout.git@main
+pip install pinout
+
+# Or upgrade to the latest version
+pip install --upgrade pinout
 ```
-NOTE for package upgrading: pip upgrade doesn't work from git repos! Please install again if you want to try out the latest version (*warning*: development is furious! Newer versions might not be backwards compatible).
 
 ### Duplicate sample files
 

diff --git a/docs/install.rst b/docs/install.rst
@@ -7,11 +7,13 @@ Install and Quickstart
 Install
 -------
 
-Using a virtual environment is recommended; Start by installing the *pinout* package. Either clone this repo and pip install it or install directly from github::
+Using a virtual environment is recommended; Start by installing the *pinout* package. Either clone this repo and pip install it or install from PyPi::
  
-    pip install git+https://github.com/j0ono0/pinout.git@main
+    pip install pinout
+
+    # Or upgrade to the latest version
+    pip install --upgrade pinout
 
-NOTE for package upgrading: pip upgrade doesn't work from git repos! Please install again if you want to try out the latest version (*warning*: new versions may not be backwards compatible).
 
 .. _quickstart:
 

diff --git a/pinout.toml b/pinout.toml
@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
diff --git a/setup.py b/setup.py
@@ -6,7 +6,7 @@
 
 setuptools.setup(
     name="pinout",
-    version="0.0.7",
+    version="0.0.8",
     author="John Newall",
     author_email="john@johnnewall.com",
     description="Generate graphical pinout references for electronic hardware.",
@@ -17,12 +17,13 @@
         "Bug Tracker": "https://github.com/j0ono0/pinout/issues",
     },
     classifiers=[
+        "Development Status :: 3 - Alpha",
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    packages=setuptools.find_packages(),
+    packages=setuptools.find_packages(include=['pinout', 'pinout.*']),
     python_requires=">=3.6",
-    install_requires=["Jinja2>=2.11.3"],
+    install_requires=["Jinja2"],
     include_package_data=True,
 )