-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add readme, license and setup script
- Loading branch information
Showing
3 changed files
with
152 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
Copyright (c) Veit Schiele. | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without modification, | ||
are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, | ||
this list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright | ||
notice, this list of conditions and the following disclaimer in the | ||
documentation and/or other materials provided with the distribution. | ||
|
||
3. Neither the name of Veit Schiele nor the names of its contributors | ||
may be used to endorse or promote products derived from this software | ||
without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | ||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR | ||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON | ||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
Jupyter-Tutorial | ||
================ | ||
|
||
* Dokumentation: https://jupyter-tutorial.readthedocs.io/en/latest/ | ||
* GitHub-Repo: https://github.com/veit/jupyter-tutorial/ | ||
* Lizenz: BSD license | ||
|
||
Installation | ||
------------ | ||
|
||
#. Herunterladen und Auspacken: | ||
|
||
$ curl -O https://github.com/veit/jupyter-tutorial/archive/master.zip | ||
$ unzip master.zip | ||
|
||
#. Sphinx installieren: | ||
|
||
$ cd jupyter-tutorial | ||
$ pipenv install | ||
|
||
#. HTML-Dokumentation erstellen: | ||
|
||
$ pipenv run sphinx-build -b html docs/ docs/_build/ | ||
|
||
#. PDF erstellen: | ||
|
||
$ pipenv shell | ||
Launching subshell in virtual environment… | ||
$ bash-3.2$ . /Users/veit/.local/share/virtualenvs/jupyter-tutorial--q5BvmfG/bin/activate | ||
$ (jupyter-tutorial) bash-3.2$ cd docs/ | ||
$ (jupyter-tutorial) bash-3.2$ make latexpdf | ||
|
||
Das PDF findet ihr anschließend in ``docs/_build/latex/jupytertutorial.pdf``. | ||
|
||
Pull-Requests | ||
------------- | ||
|
||
Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehle ich euch, | ||
mit einen *Fork* eure eigene Version zu erstellen. Ich akzeptiere auch | ||
Pull-Requests, wenn diese klein und atomar sind sowie meine eigene Erfahrung | ||
verbessern. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# !/usr/bin/env python | ||
|
||
from __future__ import print_function | ||
|
||
import os | ||
import sys | ||
|
||
try: | ||
from setuptools import setup | ||
except ImportError: | ||
from distutils.core import setup | ||
|
||
with open("README.rst", "r") as fh: | ||
long_description = fh.read() | ||
|
||
setup_args = dict( | ||
name='jupyter-tutorial', | ||
packages=[], | ||
version='0.1.0', | ||
description='Jupyter Tutorial', | ||
long_description=long_description, | ||
long_description_content_type="text/x-rst", | ||
author='Veit Schiele', | ||
license='BSD', | ||
author_email='veit@cusy.io', | ||
url='https://github.com/veit/cookiecutter-namespace-template', | ||
keywords=['jupyter', 'ipython',], | ||
classifiers=[ | ||
'Development Status :: 2 - Pre-Alpha', | ||
'Environment :: Web Environment', | ||
'Intended Audience :: Developers', | ||
'Intended Audience :: System Administrators', | ||
'Intended Audience :: Science/Research', | ||
'Natural Language :: German', | ||
'License :: OSI Approved :: BSD License', | ||
'Programming Language :: Python', | ||
'Programming Language :: Python :: 2', | ||
'Programming Language :: Python :: 2.7', | ||
'Programming Language :: Python :: 3', | ||
'Programming Language :: Python :: 3.5', | ||
'Programming Language :: Python :: 3.6', | ||
'Programming Language :: Python :: 3.7', | ||
'Framework :: IPython', | ||
'Framework :: Jupyter', | ||
'Topic :: Desktop Environment', | ||
'Topic :: Scientific/Engineering', | ||
'Topic :: Scientific/Engineering :: Visualization', | ||
'Topic :: Software Development', | ||
], | ||
install_requires=[ | ||
'sphinx', | ||
'jupyter', | ||
'nbsphinx', | ||
'pandas', | ||
'matplotlib', | ||
'cython', | ||
'memory-profiler', | ||
'pytest', | ||
'ipytest', | ||
'ipython-unittest', | ||
'jupyter-contrib-nbextensions', | ||
'yapf', | ||
'jupyter-latex-envs', | ||
'bqplot', | ||
'pythreejs', | ||
'ipyvolume', | ||
'ipyleaflet', | ||
'networkx', | ||
'autopep8', | ||
'numpy', | ||
'plotly<4', | ||
'cufflinks', | ||
'ipysheet', | ||
], | ||
) | ||
|
||
if any(bdist in sys.argv for bdist in ['bdist_wheel', 'bdist_egg']): | ||
import setuptools | ||
|
||
if __name__ == '__main__': | ||
setup(**setup_args) | ||
|