From f422a246441ca803f367a69d5c08780d8cababbb Mon Sep 17 00:00:00 2001 From: Onno Broekmans Date: Fri, 15 Jun 2018 11:11:10 +0200 Subject: [PATCH] Add full README and LICENSE; setup tweaks --- LICENSE.md | 194 +++++++++++++++++++++++++++++++++++++++++ MANIFEST.in | 2 + README.md | 54 ++++++++++++ nbkickoff/__about__.py | 2 +- setup.cfg | 2 + setup.py | 12 ++- 6 files changed, 264 insertions(+), 2 deletions(-) create mode 100644 LICENSE.md create mode 100644 MANIFEST.in diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..54273a3 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,194 @@ +# `nbkickoff` + +Copyright (c) 2018 LUMICKS B.V. + +Apache License, Version 2.0, January 2004, http://www.apache.org/licenses/ + +## TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +### 1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, +and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by +the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all +other entities that control, are controlled by, or are under common +control with that entity. For the purposes of this definition, +"control" means (i) the power, direct or indirect, to cause the +direction or management of such entity, whether by contract or +otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity +exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation +source, and configuration files. + +"Object" form shall mean any form resulting from mechanical +transformation or translation of a Source form, including but +not limited to compiled object code, generated documentation, +and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or +Object form, made available under the License, as indicated by a +copyright notice that is included in or attached to the work +(an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object +form, that is based on (or derived from) the Work and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. For the purposes +of this License, Derivative Works shall not include works that remain +separable from, or merely link (or bind by name) to the interfaces of, +the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including +the original version of the Work and any modifications or additions +to that Work or Derivative Works thereof, that is intentionally +submitted to Licensor for inclusion in the Work by the copyright owner +or by an individual or Legal Entity authorized to submit on behalf of +the copyright owner. For the purposes of this definition, "submitted" +means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, +and issue tracking systems that are managed by, or on behalf of, the +Licensor for the purpose of discussing and improving the Work, but +excluding communication that is conspicuously marked or otherwise +designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity +on behalf of whom a Contribution has been received by Licensor and +subsequently incorporated within the Work. + +### 2. Grant of Copyright License. + +Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the +Work and such Derivative Works in Source or Object form. + +### 3. Grant of Patent License. + +Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +(except as stated in this section) patent license to make, have made, +use, offer to sell, sell, import, and otherwise transfer the Work, +where such license applies only to those patent claims licensable +by such Contributor that are necessarily infringed by their +Contribution(s) alone or by combination of their Contribution(s) +with the Work to which such Contribution(s) was submitted. If You +institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work +or a Contribution incorporated within the Work constitutes direct +or contributory patent infringement, then any patent licenses +granted to You under this License for that Work shall terminate +as of the date such litigation is filed. + +### 4. Redistribution. + +You may reproduce and distribute copies of the +Work or Derivative Works thereof in any medium, with or without +modifications, and in Source or Object form, provided that You +meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +### 5. Submission of Contributions. + +Unless You explicitly state otherwise, +any Contribution intentionally submitted for inclusion in the Work +by You to the Licensor shall be under the terms and conditions of +this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify +the terms of any separate license agreement you may have executed +with Licensor regarding such Contributions. + +### 6. Trademarks. + +This License does not grant permission to use the trade +names, trademarks, service marks, or product names of the Licensor, +except as required for reasonable and customary use in describing the +origin of the Work and reproducing the content of the NOTICE file. + +### 7. Disclaimer of Warranty. + +Unless required by applicable law or +agreed to in writing, Licensor provides the Work (and each +Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied, including, without limitation, any warranties or conditions +of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. You are solely responsible for determining the +appropriateness of using or redistributing the Work and assume any +risks associated with Your exercise of permissions under this License. + +### 8. Limitation of Liability. + +In no event and under no legal theory, +whether in tort (including negligence), contract, or otherwise, +unless required by applicable law (such as deliberate and grossly +negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, +incidental, or consequential damages of any character arising as a +result of this License or out of the use or inability to use the +Work (including but not limited to damages for loss of goodwill, +work stoppage, computer failure or malfunction, or any and all +other commercial damages or losses), even if such Contributor +has been advised of the possibility of such damages. + +### 9. Accepting Warranty or Additional Liability. + +While redistributing +the Work or Derivative Works thereof, You may choose to offer, +and charge a fee for, acceptance of support, warranty, indemnity, +or other liability obligations and/or rights consistent with this +License. However, in accepting such obligations, You may act only +on Your own behalf and on Your sole responsibility, not on behalf +of any other Contributor, and only if You agree to indemnify, +defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason +of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..bf24e97 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +# Include README and LICENSE files +include *.md diff --git a/README.md b/README.md index abb33db..e9a76be 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,57 @@ Launch an IPython Notebook from a template notebook file. + +## Requirements + +Tested with: + +* Jupyter Notebook 5.5 (or higher) +* Python 3.6 + +Should also work with other Python 3.x versions. + + +## Installation + +For general use, you can install `nbkickoff` using _pip_: + + pip install nbkickoff + +To upgrade to the latest version: + + pip install -U nbkickoff + +For local development: + + git clone https://github.com/lumicks/nbkickoff.git + cd nbkickoff + pip install -e . + + +## Usage + +Invoke using either the full: + + python -m nbkickoff TEMPLATEFILE TARGETFILE [VAR=VALUE [VAR2=VALUE ...]] + +Or, if the corresponding entry point script is on the `PATH`, the shorter version: + + nbkickoff TEMPLATEFILE TARGETFILE [VAR=VALUE [VAR2=VALUE ...]] + +Here, `TEMPLATEFILE` is an IPython Notebook file that functions as a template. This file is copied to `TARGETFILE` (which must not exist yet), after which all variables in the notebook's cells are substituted with their corresponding values. + +So, if your template notebook contains a cell with the text: + + my_python_var = '{{ foo }}' + +and you invoke `nbkickoff` using: + + nbkickoff template.ipynb my_notebook.ipynb foo=bar + +Then your shiny new notebook will have a cell containing: + + my_python_var = 'bar' + +If a suitable Jupyter server process is already running, `nbkickoff` opens the new notebook in the existing server. Otherwise, a new Jupyter server process is started. This behavior is based on that of the [_nbopen_ tool](https://github.com/takluyver/nbopen/), with the notable change that `nbkickoff` always returns immediately; any newly spawned Jupyter server process is detached. + diff --git a/nbkickoff/__about__.py b/nbkickoff/__about__.py index 2cf5a90..e24659d 100644 --- a/nbkickoff/__about__.py +++ b/nbkickoff/__about__.py @@ -6,4 +6,4 @@ __author__ = 'Lumicks B.V.' __copyright__ = '2018, ' + __author__ __email__ = 'devteam@lumicks.com' -__license__ = '' +__license__ = 'Apache License 2.0' diff --git a/setup.cfg b/setup.cfg index e69de29..696a13f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +license_file = LICENSE.md \ No newline at end of file diff --git a/setup.py b/setup.py index 5dcba00..5ef5753 100644 --- a/setup.py +++ b/setup.py @@ -34,6 +34,7 @@ def read(filename): version=info['__version__'], description=info['__summary__'], long_description=read('README.md'), + long_description_content_type='text/markdown', url=info['__url__'], license=info['__license__'], @@ -43,12 +44,21 @@ def read(filename): classifiers=[ 'Development Status :: 3 - Alpha', 'Framework :: Jupyter', + 'License :: OSI Approved :: Apache Software License', 'Operating System :: OS Independent', 'Programming Language :: Python :: 3 :: Only', 'Programming Language :: Python :: 3.6', 'Topic :: Scientific/Engineering', ], - packages=find_packages(exclude=['test*']), + entry_points={ + 'console_scripts': [ + 'nbkickoff=nbkickoff.nbkickoff:main', + ], + }, + + python_requires='>=3', install_requires=requires, + packages=find_packages(exclude=['test*']), + include_package_data=True ) \ No newline at end of file