Skip to content

Commit 6cf40cc

Browse files
minrkminrk
committed
add package skeleton
1 parent 976d9da commit 6cf40cc

File tree

5 files changed

+184
-0
lines changed

5 files changed

+184
-0
lines changed

‎CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
We follow the [IPython Contributing Guide](https://github.com/ipython/ipython/blob/master/CONTRIBUTING.md).

‎COPYING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Licensing terms
2+
3+
This project is licensed under the terms of the Modified BSD License
4+
(also known as New or Revised or 3-Clause BSD), as follows:
5+
6+
- Copyright (c) 2001-, IPython Development Team
7+
8+
All rights reserved.
9+
10+
Redistribution and use in source and binary forms, with or without
11+
modification, are permitted provided that the following conditions are met:
12+
13+
Redistributions of source code must retain the above copyright notice, this
14+
list of conditions and the following disclaimer.
15+
16+
Redistributions in binary form must reproduce the above copyright notice, this
17+
list of conditions and the following disclaimer in the documentation and/or
18+
other materials provided with the distribution.
19+
20+
Neither the name of the IPython Development Team nor the names of its
21+
contributors may be used to endorse or promote products derived from this
22+
software without specific prior written permission.
23+
24+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
25+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
28+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34+
35+
## About the IPython Development Team
36+
37+
The IPython Development Team is the set of all contributors to the IPython project.
38+
This includes all of the IPython subprojects.
39+
40+
The core team that coordinates development on GitHub can be found here:
41+
https://github.com/jupyter/.
42+
43+
## Our Copyright Policy
44+
45+
IPython uses a shared copyright model. Each contributor maintains copyright
46+
over their contributions to IPython. But, it is important to note that these
47+
contributions are typically only changes to the repositories. Thus, the IPython
48+
source code, in its entirety is not the copyright of any single person or
49+
institution. Instead, it is the collective copyright of the entire IPython
50+
Development Team. If individual contributors want to maintain a record of what
51+
changes/contributions they have specific copyright on, they should indicate
52+
their copyright in the commit message of the change, when they commit the
53+
change to one of the IPython repositories.
54+
55+
With this in mind, the following banner should be used in any source code file
56+
to indicate the copyright and license terms:
57+
58+
# Copyright (c) IPython Development Team.
59+
# Distributed under the terms of the Modified BSD License.

‎MANIFEST.in

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
include COPYING.md
2+
include CONTRIBUTING.md
3+
include README.md
4+
5+
# Documentation
6+
graft docs
7+
exclude docs/\#*
8+
9+
# Examples
10+
graft examples
11+
12+
# docs subdirs we want to skip
13+
prune docs/build
14+
prune docs/gh-pages
15+
prune docs/dist
16+
17+
# Patterns to exclude from any directory
18+
global-exclude *~
19+
global-exclude *.pyc
20+
global-exclude *.pyo
21+
global-exclude .git
22+
global-exclude .ipynb_checkpoints

‎README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# IPython vestigial utilities
2+
3+
This package shouldn't exist.
4+
It contains some common utilities shared by Jupyter and IPython projects during The Big Split™.
5+
As soon as possible, those packages will remove their dependency on this,
6+
and this repo will go away.
7+
8+
No functionality should be added to this repository,
9+
and no packages outside IPython/Jupyter should depend on it.

‎setup.py

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
#!/usr/bin/env python
2+
# coding: utf-8
3+
4+
# Copyright (c) IPython Development Team.
5+
# Distributed under the terms of the Modified BSD License.
6+
7+
from __future__ import print_function
8+
9+
# the name of the project
10+
name = 'ipython_genutils'
11+
12+
#-----------------------------------------------------------------------------
13+
# Minimal Python version sanity check
14+
#-----------------------------------------------------------------------------
15+
16+
import sys
17+
18+
v = sys.version_info
19+
if v[:2] < (2,7) or (v[0] >= 3 and v[:2] < (3,3)):
20+
error = "ERROR: %s requires Python version 2.7 or 3.3 or above." % name
21+
print(error, file=sys.stderr)
22+
sys.exit(1)
23+
24+
PY3 = (sys.version_info[0] >= 3)
25+
26+
#-----------------------------------------------------------------------------
27+
# get on with it
28+
#-----------------------------------------------------------------------------
29+
30+
import os
31+
from glob import glob
32+
33+
from distutils.core import setup
34+
35+
pjoin = os.path.join
36+
here = os.path.abspath(os.path.dirname(__file__))
37+
pkg_root = pjoin(here, name)
38+
39+
packages = []
40+
for d, _, _ in os.walk(pjoin(here, name)):
41+
if os.path.exists(pjoin(d, '__init__.py')):
42+
packages.append(d[len(here)+1:].replace(os.path.sep, '.'))
43+
44+
version_ns = {}
45+
with open(pjoin(here, name, '_version.py')) as f:
46+
exec(f.read(), {}, version_ns)
47+
48+
49+
setup_args = dict(
50+
name = name,
51+
version = version_ns['__version__'],
52+
scripts = glob(pjoin('scripts', '*')),
53+
packages = packages,
54+
description = "Vestigial utilities from IPython",
55+
long_description= "Pretend this doesn't exist. Nobody should use it.",
56+
author = 'IPython Development Team',
57+
author_email = '[email protected]',
58+
url = 'http://ipython.org',
59+
license = 'BSD',
60+
platforms = "Linux, Mac OS X, Windows",
61+
keywords = ['Interactive', 'Interpreter', 'Shell', 'Web'],
62+
classifiers = [
63+
'Intended Audience :: Developers',
64+
'Intended Audience :: System Administrators',
65+
'Intended Audience :: Science/Research',
66+
'License :: OSI Approved :: BSD License',
67+
'Programming Language :: Python',
68+
'Programming Language :: Python :: 2.7',
69+
'Programming Language :: Python :: 3',
70+
'Programming Language :: Python :: 3.3',
71+
],
72+
)
73+
74+
if 'develop' in sys.argv or any(a.startswith('bdist') for a in sys.argv):
75+
import setuptools
76+
77+
setuptools_args = {}
78+
79+
install_requires = setuptools_args['install_requires'] = [
80+
81+
]
82+
83+
extras_require = setuptools_args['extras_require'] = {
84+
85+
}
86+
87+
if 'setuptools' in sys.modules:
88+
setup_args.update(setuptools_args)
89+
90+
if __name__ == '__main__':
91+
setup(**setup_args)

0 commit comments

Comments
 (0)