diff --git a/.gitignore b/.gitignore index 9e3a5f25770ca39d29e6ca4f58f12b3845a2d541..d7793bbe1d5423611c69a3c26cbc2e1ab406263f 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ -docs/_build \ No newline at end of file +**/*.egg-info/ +**/*.pyc +__init__.cpython-36.pyc \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..152577360858611f36e134d7c15d3099a2aa7fb2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,19 @@ +Copyright (c) 2018 Oliver Stocks + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..20264d30171b4703bcfa913fe2c594d921e14e3f --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# SampleProj + +An empty project set up for use next year. Suitable for release as a python package. \ No newline at end of file diff --git a/SampleProj/__init__.py b/SampleProj/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..a2b14eca7937ea037b94ad7121d4360c8d444675 100644 --- a/SampleProj/__init__.py +++ b/SampleProj/__init__.py @@ -0,0 +1 @@ +name = "SampleProj" \ No newline at end of file diff --git a/SampleProj/__pycache__/__init__.cpython-36.pyc b/SampleProj/__pycache__/__init__.cpython-36.pyc index 00299ff14f8af5a931c8c89590f1c47fceb2e463..df37090a40925f139ee69e5a3a3b78eeeb5ff2e7 100644 Binary files a/SampleProj/__pycache__/__init__.cpython-36.pyc and b/SampleProj/__pycache__/__init__.cpython-36.pyc differ diff --git a/build/lib/SampleProj/__init__.py b/build/lib/SampleProj/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..a2b14eca7937ea037b94ad7121d4360c8d444675 --- /dev/null +++ b/build/lib/SampleProj/__init__.py @@ -0,0 +1 @@ +name = "SampleProj" \ No newline at end of file diff --git a/build/lib/SampleProj/numpyDocsTemp.py b/build/lib/SampleProj/numpyDocsTemp.py new file mode 100644 index 0000000000000000000000000000000000000000..c0c1c0ad39fb5c1ba73076b51838bb67d9bf5e92 --- /dev/null +++ b/build/lib/SampleProj/numpyDocsTemp.py @@ -0,0 +1,123 @@ +"""This is the docstring for the numpyDocsTemp.py module. Modules names should +have short, all-lowercase names. The module name may have underscores if +this improves readability. + +Every module should have a docstring at the very top of the file. The +module's docstring may extend over multiple lines. If your docstring does +extend over multiple lines, the closing three quotation marks must be on +a line by itself, preferably preceded by a blank line. + +""" +from __future__ import division, absolute_import, print_function + +import os # standard library imports first + +# Do NOT import using *, e.g. from numpy import * +# +# Import the module using +# +# import numpy +# +# instead or import individual functions as needed, e.g +# +# from numpy import array, zeros +# +# If you prefer the use of abbreviated module names, we suggest the +# convention used by NumPy itself:: + +import numpy as np +import matplotlib as mpl +import matplotlib.pyplot as plt + +# These abbreviated names are not to be used in docstrings; users must +# be able to paste and execute docstrings after importing only the +# numpy module itself, unabbreviated. + + +def foo(var1, var2, long_var_name='hi'): + r"""A one-line summary that does not use variable names or the + function name. + + Several sentences providing an extended description. Refer to + variables using back-ticks, e.g. `var`. + + Parameters + ---------- + var1 : array_like + Array_like means all those objects -- lists, nested lists, etc. -- + that can be converted to an array. We can also refer to + variables like `var1`. + var2 : int + The type above can either refer to an actual Python type + (e.g. ``int``), or describe the type of the variable in more + detail, e.g. ``(N,) ndarray`` or ``array_like``. + long_var_name : {'hi', 'ho'}, optional + Choices in brackets, default first when optional. + + Returns + ------- + type + Explanation of anonymous return value of type ``type``. + describe : type + Explanation of return value named `describe`. + out : type + Explanation of `out`. + type_without_description + + Other Parameters + ---------------- + only_seldom_used_keywords : type + Explanation + common_parameters_listed_above : type + Explanation + + Raises + ------ + BadException + Because you shouldn't have done that. + + See Also + -------- + otherfunc : relationship (optional) + newfunc : Relationship (optional), which could be fairly long, in which + case the line wraps here. + thirdfunc, fourthfunc, fifthfunc + + Notes + ----- + Notes about the implementation algorithm (if needed). + + This can have multiple paragraphs. + + You may include some math: + + .. math:: X(e^{j\omega } ) = x(n)e^{ - j\omega n} + + And even use a Greek symbol like :math:`\omega` inline. + + References + ---------- + Cite the relevant literature, e.g. [1]_. You may also cite these + references in the notes section above. + + .. [1] O. McNoleg, "The integration of GIS, remote sensing, + expert systems and adaptive co-kriging for environmental habitat + modelling of the Highland Haggis using object-oriented, fuzzy-logic + and neural-network techniques," Computers & Geosciences, vol. 22, + pp. 585-588, 1996. + + Examples + -------- + These are written in doctest format, and should illustrate how to + use the function. + + >>> a = [1, 2, 3] + >>> print [x + 3 for x in a] + [4, 5, 6] + >>> print "a\n\nb" + a + b + + """ + + pass diff --git a/dist/SampleProj-0.0.2-py3-none-any.whl b/dist/SampleProj-0.0.2-py3-none-any.whl new file mode 100644 index 0000000000000000000000000000000000000000..36d9f021d215f010c783b1288ddbac78713222fa Binary files /dev/null and b/dist/SampleProj-0.0.2-py3-none-any.whl differ diff --git a/dist/SampleProj-0.0.2.tar.gz b/dist/SampleProj-0.0.2.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..4125e42cd84da7bbee44338959b0f33ba2315c3b Binary files /dev/null and b/dist/SampleProj-0.0.2.tar.gz differ diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000000000000000000000000000000000..a01452a82d2745a49c4714481e539016c1a71e43 --- /dev/null +++ b/setup.py @@ -0,0 +1,21 @@ +import setuptools + +with open("README.md", "r") as fh: + long_desc = fh.read() + +setuptools.setup( + name = "SampleProj", + version = "0.0.2", + author = "Oliver Stocks", + author_email = "ojs1g14@soton.ac.uk", + description = "Sample package for use on a fourth year project", + long_description = long_desc, + long_description_content_type="text/markdown", + url="https://git.soton.ac.uk/ojs1g14/SampleProj", + packages=setuptools.find_packages(), + classifiers= ( + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: Microsoft :: Windows", + ), +) \ No newline at end of file