/ setup.py
setup.py
1 # coding=utf-8 2 3 ######################################################################################################################## 4 ### Do not forget to adjust the following variables to your own plugin. 5 6 # The plugin's identifier, has to be unique 7 plugin_identifier = "flashforge" 8 9 # The plugin's python package, should be "octoprint_<plugin identifier>", has to be unique 10 plugin_package = "octoprint_flashforge" 11 12 # The plugin's human readable name. Can be overwritten within OctoPrint's internal data via __plugin_name__ in the 13 # plugin module 14 plugin_name = "OctoPrint-FlashForge" 15 16 # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module 17 plugin_version = "0.1.18" 18 19 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin 20 # module 21 plugin_description = """Support communications with closed source FlashForge printers (Finder, Dreamer, PowerSpec Ultra, etc)""" 22 23 # The plugin's author. Can be overwritten within OctoPrint's internal data via __plugin_author__ in the plugin module 24 plugin_author = "Mrnt" 25 26 # The plugin's author's mail address. 27 plugin_author_email = "it@maurent.com" 28 29 # The plugin's homepage URL. Can be overwritten within OctoPrint's internal data via __plugin_url__ in the plugin module 30 plugin_url = "https://github.com/Mrnt/OctoPrint-FlashForge" 31 32 # The plugin's license. Can be overwritten within OctoPrint's internal data via __plugin_license__ in the plugin module 33 plugin_license = "AGPLv3" 34 35 # Any additional requirements besides OctoPrint should be listed here 36 plugin_requires = ['libusb1'] 37 38 ### -------------------------------------------------------------------------------------------------------------------- 39 ### More advanced options that you usually shouldn't have to touch follow after this point 40 ### -------------------------------------------------------------------------------------------------------------------- 41 42 # Additional package data to install for this plugin. The subfolders "templates", "static" and "translations" will 43 # already be installed automatically if they exist. Note that if you add something here you'll also need to update 44 # MANIFEST.in to match to ensure that python setup.py sdist produces a source distribution that contains all your 45 # files. This is sadly due to how python's setup.py works, see also http://stackoverflow.com/a/14159430/2028598 46 plugin_additional_data = [] 47 48 # Any additional python packages you need to install with your plugin that are not contained in <plugin_package>.* 49 plugin_additional_packages = [] 50 51 # Any python packages within <plugin_package>.* you do NOT want to install with your plugin 52 plugin_ignored_packages = [] 53 54 # Additional parameters for the call to setuptools.setup. If your plugin wants to register additional entry points, 55 # define dependency links or other things like that, this is the place to go. Will be merged recursively with the 56 # default setup parameters as provided by octoprint_setuptools.create_plugin_setup_parameters using 57 # octoprint.util.dict_merge. 58 # 59 # Example: 60 # plugin_requires = ["someDependency==dev"] 61 # additional_setup_parameters = {"dependency_links": ["https://github.com/someUser/someRepo/archive/master.zip#egg=someDependency-dev"]} 62 additional_setup_parameters = {} 63 64 ######################################################################################################################## 65 66 from setuptools import setup 67 68 try: 69 import octoprint_setuptools 70 except: 71 print("Could not import OctoPrint's setuptools, are you sure you are running that under " 72 "the same python installation that OctoPrint is installed under?") 73 import sys 74 sys.exit(-1) 75 76 setup_parameters = octoprint_setuptools.create_plugin_setup_parameters( 77 identifier=plugin_identifier, 78 package=plugin_package, 79 name=plugin_name, 80 version=plugin_version, 81 description=plugin_description, 82 author=plugin_author, 83 mail=plugin_author_email, 84 url=plugin_url, 85 license=plugin_license, 86 requires=plugin_requires, 87 additional_packages=plugin_additional_packages, 88 ignored_packages=plugin_ignored_packages, 89 additional_data=plugin_additional_data 90 ) 91 92 if len(additional_setup_parameters): 93 from octoprint.util import dict_merge 94 setup_parameters = dict_merge(setup_parameters, additional_setup_parameters) 95 96 setup(**setup_parameters)