setup for pypi

Author: AndyEveritt

DuetWebAPI/__init__.py

@@ -1 +1,3 @@
+__version__ = "1.0.1"
+
 from .dwa_factory import DuetWebAPI

DuetWebAPI/dwa_factory.py

@@ -1,23 +1,20 @@
 # Python Script containing a class to send commands to, and query specific information from,
-#   Duet based printers running either Duet RepRap V2 or V3 firmware.
+#   Duet based printers running Duet RepRap V3 firmware.
 #
 # Does NOT hold open the connection.  Use for low-volume requests.
 # Does NOT, at this time, support Duet passwords.
 #
-# Not intended to be a gerneral purpose interface; instead, it contains methods
-# to issue commands or return specific information. Feel free to extend with new
-# methods for other information; please keep the abstraction for V2 V3
-#
-# Copyright (C) 2020 Danal Estes all rights reserved.
+# Copyright (C) 2020 Andy Everitt all rights reserved.
 # Released under The MIT License. Full text available via https://opensource.org/licenses/MIT
 #
 # Requires Python3
+
 import logging
 from typing import Dict, List
 
 import requests
 
-from DuetWebAPI.api import DSFAPI, DWCAPI, DuetAPI, DuetAPIWrapper
+from .api import DSFAPI, DWCAPI, DuetAPI, DuetAPIWrapper
 
 
 class DuetWebAPIFactory:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Danal
+Copyright (c) 2020 Andy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,11 @@
+SHELL := /bin/bash
+verbosity=1
+
+update_dist:
+	python setup.py sdist bdist_wheel
+
+check_dist:
+	twine check dist/*-$(v)*
+
+upload_test:
+	twine upload --repository testpypi dist/*-$(v)*

README.md

@@ -9,8 +9,14 @@ Python interface to Duet RepRap V3 firmware via Http REST API.
   * Duet 2 standalone
 
 # Install
-* add `-e "git+https://github.com/AndyEveritt/DuetWebAPI.git@master#egg=duetwebapi"` to `requirements.txt`
-* `pip install -r requirements.txt`
+```
+pip install duetwebapi
+```
+
+Alternatively:
+```
+pip install -e "git+https://github.com/AndyEveritt/DuetWebAPI.git@master#egg=duetwebapi"
+```
 
 # Usage
 * See 'examples.py' for examples. 

examples.py

@@ -1,55 +1,55 @@
 #!/usr/bin/env python3
-from DuetWebAPI import DuetWebAPI as DWA
+from duetwebapi import DuetWebAPI as DWA
 import json
 
 ###################################
 # Create API link
 ###################################
 riley = DWA('http://riley')
-force_rig = DWA('http://forcerig')
+bruce = DWA('http://bruce')
 
 ###################################
 # REST API methods
 ###################################
 riley.get_model()
-force_rig.get_model()
+bruce.get_model()
 
 riley.post_code('M115')
-force_rig.post_code('M115')
+bruce.post_code('M115')
 
 riley.put_file('test.gcode')
-force_rig.put_file('test.gcode')
+bruce.put_file('test.gcode')
 
 riley.get_file('test.gcode')
-force_rig.get_file('test.gcode')
+bruce.get_file('test.gcode')
 
 riley.move_file('gcodes/test.gcode', 'gcodes/test2.gcode')
-# force_rig.move_file('gcodes/test.gcode', 'gcodes/test2.gcode')
+# bruce.move_file('gcodes/test.gcode', 'gcodes/test2.gcode')
 
 riley.delete_file('test2.gcode')
-force_rig.delete_file('test2.gcode')
+bruce.delete_file('test2.gcode')
 
 riley.get_directory('gcodes')
-force_rig.get_directory('gcodes')
+bruce.get_directory('gcodes')
 
 ###################################
 # Wrapper methods
 ###################################
 riley.get_coords()
-force_rig.get_coords()
+bruce.get_coords()
 
 riley.get_layer()
-force_rig.get_layer()
+bruce.get_layer()
 
 riley.get_num_extruders()
-force_rig.get_num_extruders()
+bruce.get_num_extruders()
 
 riley.get_num_tools()
-force_rig.get_num_tools()
+bruce.get_num_tools()
 
 riley.get_status()
-force_rig.get_status()
+bruce.get_status()
 
 riley.get_temperatures()
-force_rig.get_temperatures()
+bruce.get_temperatures()
 pass

requirement.txt requirements.txtrequirement.txt renamed to requirements.txt

@@ -0,0 +1,24 @@
+autopep8==1.5.4
+bleach==3.2.1
+certifi==2020.6.20
+chardet==3.0.4
+colorama==0.4.4
+docutils==0.16
+idna==2.10
+keyring==21.4.0
+packaging==20.4
+pkginfo==1.6.1
+pycodestyle==2.6.0
+Pygments==2.7.2
+pyparsing==2.4.7
+pywin32-ctypes==0.2.0
+readme-renderer==28.0
+requests==2.24.0
+requests-toolbelt==0.9.1
+rfc3986==1.4.0
+six==1.15.0
+toml==0.10.1
+tqdm==4.51.0
+twine==3.2.0
+urllib3==1.25.11
+webencodings==0.5.1

requirements_dev.txt

@@ -1,8 +1,15 @@
 from setuptools import find_packages, setup
+import pathlib
+
+# The directory containing this file
+HERE = pathlib.Path(__file__).parent
+
+# The text of the README file
+README = (HERE / "README.md").read_text()
 
 setup(
     name="duetwebapi",
-    version="0.0.1",
+    version="1.0.1",
     include_package_data=True,
     packages=find_packages(),
 
@@ -13,8 +20,11 @@
     author="Andy Everitt",
     author_email="andreweveritt@e3d-online.com",
     description="Python interface to Duet REST API",
+    long_description=README,
+    long_description_content_type="text/markdown",
     url="https://github.com/AndyEveritt/DuetWebAPI",
     classifiers=[
+        "License :: OSI Approved :: MIT License",
         "Programming Language :: Python :: 3",
         "Operating System :: OS Independent",
     ],