Issue #34, migrate namespace for v1.0.0

alkaline-ml · Oct 3, 2018 · 8487dae · 8487dae
1 parent add954f
commit 8487dae
Show file tree

Hide file tree

Showing 87 changed files with 203 additions and 206 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -2,15 +2,15 @@
 show_missing = True
 
 [run]
-source = pyramid
-include = */pyramid/*
+source = pmdarima
+include = */pmdarima/*
 omit =
     */setup.py
-    */pyramid/__check_build/*
-    */pyramid/_build_utils/*
-    */pyramid/_config.py
-    */pyramid/setup.py
-    */pyramid/__init__.py
-    */pyramid/compat/matplotlib.py
-    */pyramid/utils/tests/test_vis.py
-    */pyramid/utils/visualization.py
+    */pmdarima/__check_build/*
+    */pmdarima/_build_utils/*
+    */pmdarima/_config.py
+    */pmdarima/setup.py
+    */pmdarima/__init__.py
+    */pmdarima/compat/matplotlib.py
+    */pmdarima/utils/tests/test_vis.py
+    */pmdarima/utils/visualization.py
diff --git a/.gitignore b/.gitignore
@@ -31,7 +31,7 @@ __pycache__/
 
 # C extensions
 *.so
-pyramid/arima/_arima.html
+pmdarima/arima/_arima.html
 
 # Distribution / packaging
 .Python

diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -24,7 +24,7 @@ model = auto_arima(your_data, stepwise=True)
 Please run the following snippet and paste the output below.
 import platform; print(platform.platform())
 import sys; print("Python", sys.version)
-import pyramid; print("Pyramid", pyramid.__version__)
+import pmdarima; print("Pyramid", pmdarima.__version__)
 import numpy; print("NumPy", numpy.__version__)
 import scipy; print("SciPy", scipy.__version__)
 import sklearn; print("Scikit-Learn", sklearn.__version__)

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,9 +1,9 @@
 # recursive-include doc *
 recursive-include examples *
-recursive-include pyramid/__check_build *.c *.pyx *.pyd *.so *.dylib *.dll
-recursive-include pyramid/arima *.c *.pyx *.pyd *.so *.dylib *.dll
-recursive-include pyramid/compat *.pyx *.pyd
-recursive-include pyramid/datasets *.pyx *.pyd
-recursive-include pyramid/utils *.pyx *.pyd
+recursive-include pmdarima/__check_build *.c *.pyx *.pyd *.so *.dylib *.dll
+recursive-include pmdarima/arima *.c *.pyx *.pyd *.so *.dylib *.dll
+recursive-include pmdarima/compat *.pyx *.pyd
+recursive-include pmdarima/datasets *.pyx *.pyd
+recursive-include pmdarima/utils *.pyx *.pyd
 include README.md
 include requirements.txt
diff --git a/Makefile b/Makefile
@@ -30,7 +30,7 @@ inplace:
 	$(PYTHON) setup.py build_ext -i
 
 test-code: in
-	$(NOSETESTS) -s -v pyramid
+	$(NOSETESTS) -s -v pmdarima
 
 # test-sphinxext:
 #	$(NOSETESTS) -s -v doc/sphinxext/
@@ -43,7 +43,7 @@ test-code: in
 
 test-coverage:
 	rm -rf coverage .coverage
-	$(NOSETESTS) -s -v --with-coverage pyramid
+	$(NOSETESTS) -s -v --with-coverage pmdarima
 
 #test: test-code test-sphinxext test-doc
 
@@ -56,7 +56,7 @@ cython:
 ctags:
 	# make tags for symbol based navigation in emacs and vim
 	# Install with: sudo apt-get install exuberant-ctags
-	$(CTAGS) --python-kinds=-i -R pyramid
+	$(CTAGS) --python-kinds=-i -R pmdarima
 
 #doc: inplace
 #	$(MAKE) -C doc html
@@ -65,8 +65,8 @@ ctags:
 #	$(MAKE) -C doc html-noplot
 
 code-analysis:
-	flake8 pyramid | grep -v __init__ | grep -v external
-	pylint -E -i y pyramid/ -d E1103,E0611,E1101
+	flake8 pmdarima | grep -v __init__ | grep -v external
+	pylint -E -i y pmdarima/ -d E1103,E0611,E1101
 
 #flake8-diff:
 #./build_tools/travis/flake8_diff.sh
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ $ pip install pyramid-arima
 To ensure the package was built correctly, import the following module in python:
 
 ```python
-from pyramid.arima import auto_arima
+from pmdarima.arima import auto_arima
 ```
 
 

diff --git a/appveyor.yml b/appveyor.yml
@@ -87,7 +87,7 @@ test_script:
   - "cd ../empty_folder"
 
   # Test with pytest
-  - "pytest --showlocals --durations=20 --pyargs pyramid"
+  - "pytest --showlocals --durations=20 --pyargs pmdarima"
   - "cd ../pyramid"
 
 after_test:

diff --git a/build_tools/circle/build_test_pypy.sh b/build_tools/circle/build_test_pypy.sh
@@ -32,4 +32,4 @@ pip install -vv -e .
 
 # Pytest is known to consume lots of memory for a large number of tests,
 # and Circle 2.0 limits 4GB per container.
-python -m pytest pyramid/ -p no:logging
+python -m pytest pmdarima/ -p no:logging
diff --git a/build_tools/doc/build_push_doc.sh b/build_tools/doc/build_push_doc.sh
@@ -4,7 +4,7 @@ set -e
 
 # this is a hack, but we have to make sure we're only ever running this from
 # the top level of the package and not in the subdirectory...
-if [[ ! -d pyramid/__check_build ]]; then
+if [[ ! -d pmdarima/__check_build ]]; then
     echo "This must be run from the pyramid project directory"
     exit 3
 fi
@@ -60,8 +60,8 @@ declare -a leftover=(".cache/"
                      "build_tools/"
                      "doc/"
                      "examples/"
-                     "pyramid/"
-                     "pyramid.egg-info/"
+                     "pmdarima/"
+                     "pmdarima.egg-info/"
                      "_downloads/"
                      "_images/"
                      "_modules/"

diff --git a/build_tools/travis/after_success.sh b/build_tools/travis/after_success.sh
@@ -29,7 +29,7 @@ fi
 pip install twine || "pip installing twine failed"
 
 # remove the .egg-info dir so Mac won't bomb on bdist_wheel cmd (absolute path in SOURCES.txt)
-rm -r pyramid_arima.egg-info/ || echo "No local .egg cache to remove"
+rm -r pmdarima.egg-info/ || echo "No local .egg cache to remove"
 
 # make a dist folder if not there, then make sure permissions are sufficient
 mkdir -p dist

diff --git a/build_tools/travis/install.sh b/build_tools/travis/install.sh
@@ -91,7 +91,7 @@ fi
 # now run the python setup. This implicitly builds all the C code with build_ext
 python setup.py develop
 
-# Build pyramid in the install.sh script to collapse the verbose
+# Build pmdarima in the install.sh script to collapse the verbose
 # build output in the travis output when it succeeds.
 python --version
 python -c "import numpy; print('numpy %s' % numpy.__version__)"

diff --git a/build_tools/travis/test_script.sh b/build_tools/travis/test_script.sh
@@ -28,7 +28,7 @@ run_tests() {
     if [[ "$COVERAGE" == "true" ]]; then
         TEST_CMD="$TEST_CMD --cov-config .coveragerc --cov pyramid"
     fi
-    $TEST_CMD pyramid
+    $TEST_CMD pmdarima
 
     # Going back to git checkout folder needed for make test-doc
     cd $OLDPWD

diff --git a/doc/_static/css/gitcontrib.css b/doc/_static/css/gitcontrib.css
@@ -7,7 +7,7 @@
 }
 
 .contrib-wrapper {
-  position absolute;
+  position: absolute;
   display: block;
   height: 80px;
   width: 450px;

diff --git a/doc/about.rst b/doc/about.rst
@@ -4,7 +4,7 @@
 About the project
 =================
 
-Pyramid is designed to behave as similarly to R's well-known
+Pyramid-arima is designed to behave as similarly to R's well-known
 `auto.arima <https://www.rdocumentation.org/packages/forecast/versions/8.4/topics/auto.arima>`_
 as possible.
 
@@ -25,7 +25,7 @@ and machine learning libraries (statsmodels and scikit-learn), and operates by g
 all ARIMA models into a single class (unlike statsmodels).
 
 It does this by wrapping the respective statsmodels interfaces
-(``ARMA``, ``ARIMA`` and ``SARIMAX``) inside the ``pyramid.ARIMA`` class,
+(``ARMA``, ``ARIMA`` and ``SARIMAX``) inside the ``pmdarima.ARIMA`` class,
 and as a result there is a bit of monkey patching that happens beneath the hood.
 
 How ``auto_arima`` works
@@ -50,7 +50,7 @@ This is an open-source (read: *FREE*) project. That means several things:
 * It's a community effort
 * Making demands doesn't go over well
 
-I know that there are those who have built models with Pyramid as a tool
+I know that there are those who have built models with Pyramid-arima as a tool
 to support their work. I also know that people can depend on the functionality of
 this library in order to do their job well. And for that, I'm committed to
 keeping things running smoothly.

diff --git a/doc/conf.py b/doc/conf.py
@@ -30,7 +30,7 @@
 
 import os
 import sys
-import pyramid
+import pmdarima
 from pkg_resources import parse_version
 from sklearn.externals.six import u
 
@@ -92,7 +92,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = str(parse_version(pyramid.__version__))
+version = str(parse_version(pmdarima.__version__))
 # The full version, including alpha/beta/rc tags.
 release = version
 

diff --git a/doc/contributing.rst b/doc/contributing.rst
@@ -1,8 +1,8 @@
 .. _contrib:
 
-=======================
-Contributing to Pyramid
-=======================
+=============================
+Contributing to Pyramid-arima
+=============================
 
 **Note: This document is a 'getting started' summary for contributing code,
 documentation, testing, and filing issues.** Please read it carefully to help

diff --git a/doc/modules/classes.rst b/doc/modules/classes.rst
@@ -6,22 +6,22 @@ API Reference
 
 .. include:: ../includes/api_css.rst
 
-This is the class and function reference for pyramid. Please refer to
+This is the class and function reference for ``pmdarima``. Please refer to
 the :ref:`full user guide <user_guide>` for further details, as the class and
 function raw specifications may not be enough to give full guidelines on their
 uses.
 
 
 .. _arima_ref:
 
-:mod:`pyramid.arima`: ARIMA estimator & differencing tests
-==========================================================
+:mod:`pmdarima.arima`: ARIMA estimator & differencing tests
+===========================================================
 
-The ``pyramid.arima`` sub-module defines the ``ARIMA`` estimator and the
+The ``pmdarima.arima`` sub-module defines the ``ARIMA`` estimator and the
 ``auto_arima`` function, as well as a set of tests of seasonality and
 stationarity.
 
-.. automodule:: pyramid.arima
+.. automodule:: pmdarima.arima
     :no-members:
     :no-inherited-members:
 
@@ -31,7 +31,7 @@ ARIMA estimator & statistical tests
 **User guide:** See the :ref:`seasonality` and :ref:`enforcing_stationarity`
 sections for further details.
 
-.. currentmodule:: pyramid
+.. currentmodule:: pmdarima
 
 .. autosummary::
     :toctree: generated/
@@ -48,7 +48,7 @@ ARIMA auto-parameter selection
 
 **User guide:** See the :ref:`tips_and_tricks` section for further details.
 
-.. currentmodule:: pyramid
+.. currentmodule:: pmdarima
 
 .. autosummary::
     :toctree: generated/
@@ -60,7 +60,7 @@ ARIMA auto-parameter selection
 Differencing helpers
 --------------------
 
-.. currentmodule:: pyramid
+.. currentmodule:: pmdarima
 
 .. autosummary::
     :toctree: generated/
@@ -73,23 +73,23 @@ Differencing helpers
 
 .. _datasets_ref:
 
-:mod:`pyramid.datasets`: Toy univariate timeseries datasets
-===========================================================
+:mod:`pmdarima.datasets`: Toy univariate timeseries datasets
+============================================================
 
-The ``pyramid.datasets`` submodule provides several different univariate time-
+The ``pmdarima.datasets`` submodule provides several different univariate time-
 series datasets used in various examples and tests across the package. If you
 would like to prototype a model, this is a good place to find easy-to-access data.
 
 **User guide:** See the :ref:`datasets` section for further details.
 
-.. automodule:: pyramid.datasets
+.. automodule:: pmdarima.datasets
     :no-members:
     :no-inherited-members:
 
 Dataset loading functions
 -------------------------
 
-.. currentmodule:: pyramid
+.. currentmodule:: pmdarima
 
 .. autosummary::
     :toctree: generated/
@@ -102,19 +102,19 @@ Dataset loading functions
 
 .. _utils_ref:
 
-:mod:`pyramid.utils`: Utilities
-===============================
+:mod:`pmdarima.utils`: Utilities
+================================
 
 Utilities and array differencing functions used commonly across the package.
 
-.. automodule:: pyramid.utils
+.. automodule:: pmdarima.utils
     :no-members:
     :no-inherited-members:
 
 Array helper functions & metaestimators
 ---------------------------------------
 
-.. currentmodule:: pyramid
+.. currentmodule:: pmdarima
 
 .. autosummary::
     :toctree: generated/
@@ -131,7 +131,7 @@ Array helper functions & metaestimators
 Plotting utilities & wrappers
 -----------------------------
 
-.. currentmodule:: pyramid
+.. currentmodule:: pmdarima
 
 .. autosummary::
     :toctree: generated/

diff --git a/examples/README.txt b/examples/README.txt
@@ -6,7 +6,7 @@ Examples
 General examples
 ----------------
 
-General-purpose and introductory examples for pyramid. These examples are
+General-purpose and introductory examples for ``pmdarima``. These examples are
 designed to introduce you to the package style and layout.
 
 .. raw:: html

diff --git a/examples/arima/README.txt b/examples/arima/README.txt
@@ -3,7 +3,7 @@
 ARIMA examples
 --------------
 
-Examples of how to use the :mod:`pyramid.arima` module to fit timeseries
+Examples of how to use the :mod:`pmdarima.arima` module to fit timeseries
 models.
 
 .. raw:: html

diff --git a/examples/arima/example_add_new_samples.py b/examples/arima/example_add_new_samples.py
@@ -16,8 +16,8 @@
 
 # Author: Taylor Smith <[email protected]>
 
-from pyramid.datasets import load_lynx
-from pyramid.arima import auto_arima
+from pmdarima.datasets import load_lynx
+from pmdarima.arima import auto_arima
 import matplotlib.pyplot as plt
 import numpy as np
 

diff --git a/examples/arima/example_auto_arima.py b/examples/arima/example_auto_arima.py
@@ -16,8 +16,8 @@
 
 # Author: Taylor Smith <[email protected]>
 
-from pyramid.datasets import load_lynx
-from pyramid.arima import auto_arima
+from pmdarima.datasets import load_lynx
+from pmdarima.arima import auto_arima
 from sklearn.metrics import mean_squared_error
 import matplotlib.pyplot as plt
 import numpy as np

diff --git a/examples/arima/example_persisting_a_model.py b/examples/arima/example_persisting_a_model.py
@@ -16,7 +16,7 @@
 # Author: Taylor Smith <[email protected]>
 
 import pyramid as pm
-from pyramid.datasets import load_wineind
+from pmdarima.datasets import load_wineind
 from sklearn.externals import joblib  # for persistence
 import os