Make as a package

rlan · Oct 26, 2018 · be1df1e · be1df1e
1 parent 9826f1a
commit be1df1e
Show file tree

Hide file tree

Showing 12 changed files with 48 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,15 +1,3 @@
-
-# Created by https://www.gitignore.io/api/visualstudiocode
-### VisualStudioCode ###
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-.history
-# End of https://www.gitignore.io/api/visualstudiocode
-
-
 # Created by https://www.gitignore.io/api/python
 ### Python ###
 # Byte-compiled / optimized / DLL files

diff --git a/.travis.yml b/.travis.yml
@@ -2,11 +2,13 @@ language: python
 matrix:
   include:
   - python: "2.7"
+  - python: "3.5"
   - python: "3.6"
+  - python: "3.7"
 install:
   - pip install -r requirements.txt
 script:
-  - python BoundingBox.py
-  - python Patience.py
-  - python RunningMean.py
-  - python RunningVariance.py
+  - python pyml/BoundingBox.py
+  - python pyml/Patience.py
+  - python pyml/RunningMean.py
+  - python pyml/RunningVariance.py
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Machine Learning Utility Library in Python
+# A Machine Learning Utility Library in Python
 
 A collection of loosely organized code to assist machine learning research.
 
@@ -10,3 +10,15 @@ Branch | Status
 --- | ---
 [master](https://github.com/rlan/pyml/tree/master) | [![Test Status](https://travis-ci.org/rlan/pyml.svg?branch=master)](https://travis-ci.org/rlan/pyml)
 [develop](https://github.com/rlan/pyml/tree/develop) | [![Test Status](https://travis-ci.org/rlan/pyml.svg?branch=develop)](https://travis-ci.org/rlan/pyml)
+
+## Installation
+
+```sh
+pip install git+https://github.com/rlan/pyml.git
+```
+
+## Usage
+
+```python
+import pyml
+```
diff --git a/VERSION b/VERSION
@@ -0,0 +1 @@
+0.1.0
diff --git a/BoundingBox.py → pyml/BoundingBox.py b/BoundingBox.py → pyml/BoundingBox.py
diff --git a/Image.py → pyml/Image.py b/Image.py → pyml/Image.py
diff --git a/Patience.py → pyml/Patience.py b/Patience.py → pyml/Patience.py
diff --git a/RunningMean.py → pyml/RunningMean.py b/RunningMean.py → pyml/RunningMean.py
diff --git a/RunningVariance.py → pyml/RunningVariance.py b/RunningVariance.py → pyml/RunningVariance.py
diff --git a/__init__.py → pyml/__init__.py b/__init__.py → pyml/__init__.py
diff --git a/mnist.py → pyml/mnist.py b/mnist.py → pyml/mnist.py
diff --git a/setup.py b/setup.py
@@ -0,0 +1,28 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+  long_description = fh.read()
+
+with open("VERSION", "r") as fh:
+  version = fh.read()
+
+setuptools.setup(
+  name="pyml",
+  version=version,
+  author="Rick Lan",
+  author_email="rlan@users.noreply.github.com",
+  description="A Machine Learning Utility Library",
+  long_description=long_description,
+  long_description_content_type="text/markdown",
+  license="MIT License",
+  url="https://github.com/rlan/pyml",
+  packages=setuptools.find_packages(),
+  classifiers=[
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+  ],
+  install_requires=[
+    "numpy >= 1.13.3",
+  ]
+)