Merge pull request #3 from AnnaliseAI/feature/Issue1

Feature/issue1
annaliseai · Dec 3, 2020 · ab790a6 · ab790a6
2 parents 4621b7d + a0a0361
commit ab790a6
Show file tree

Hide file tree

Showing 31 changed files with 627 additions and 260 deletions.
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
diff --git a/.coveragerc b/.coveragerc
@@ -10,12 +10,12 @@ parallel = true
 
 [paths]
 source =
-    s3pkgup 
+    pips3 
 
 [report]
 precision = 2
 include =
-    s3pkgup/*.py 
+    pips3/*.py 
 exclude_lines =
     def __str__
     pragma: no cover

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,5 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## v0.1
+## [0.1.0] - 27-10-2020
+### Added
+* First release into pypi
+* Removed annalise.ai specific details
+* Improved test coverage
+* Configuration via environment variables 
 
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,9 +1,8 @@
 include README.rst
 include versioneer.py
-include s3pkgup/_version.py
-include s3pkgup/data/index.html.j2
+include pips3/_version.py
 
-recursive-include tests *
+recursive-exclude tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 

diff --git a/Makefile b/Makefile
@@ -51,7 +51,7 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr .pytest_cache
 
 lint: ## check style with flake8
-	flake8 s3pkgup tests
+	flake8 pips3 tests
 
 test: ## run tests quickly with the default Python
 	pytest
@@ -60,15 +60,15 @@ test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source s3pkgup -m pytest
+	coverage run --source pips3 -m pytest
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/s3pkgup.rst
+	rm -f docs/pips3.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ s3pkgup
+	sphinx-apidoc -o docs/ pips3
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# pips3
+
+Python Boilerplate contains all the boilerplate you need to create a Python package.
+
+## Features
+
+* TODO
+
+### Credits
+
+This package was created with [Cookiecutter(https://github.com/audreyr/cookiecutter) and the [annalise.ai cookiecutter](https://github.com/AnnaliseAI/pythonpackagecookie) project template.
diff --git a/README.rst b/README.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# s3pkgup documentation build configuration file, created by
+# pips3 documentation build configuration file, created by
 # sphinx-quickstart on Fri Jun  9 13:47:02 2017.
 #
 # This file is execfile()d with the current directory set to its
@@ -22,7 +22,7 @@
 import sys
 sys.path.insert(0, os.path.abspath('..'))
 
-import s3pkgup
+import pips3
 
 # -- General configuration ---------------------------------------------
 
@@ -63,7 +63,7 @@ def setup(app):
 master_doc = 'index'
 
 # General information about the project.
-project = u's3pkgup'
+project = u'pips3'
 copyright = u"2020, Ben Johnston"
 author = u"Ben Johnston"
 
@@ -72,9 +72,9 @@ def setup(app):
 # the built documents.
 #
 # The short X.Y version.
-version = s3pkgup.__version__
+version = pips3.__version__
 # The full version, including alpha/beta/rc tags.
-release = s3pkgup.__version__
+release = pips3.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -117,7 +117,7 @@ def setup(app):
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 's3pkgupdoc'
+htmlhelp_basename = 'pips3doc'
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -144,8 +144,8 @@ def setup(app):
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 's3pkgup.tex',
-     u's3pkgup Documentation',
+    (master_doc, 'pips3.tex',
+     u'pips3 Documentation',
      u'Ben Johnston', 'manual'),
 ]
 
@@ -155,8 +155,8 @@ def setup(app):
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 's3pkgup',
-     u's3pkgup Documentation',
+    (master_doc, 'pips3',
+     u'pips3 Documentation',
      [author], 1)
 ]
 
@@ -167,10 +167,10 @@ def setup(app):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 's3pkgup',
-     u's3pkgup Documentation',
+    (master_doc, 'pips3',
+     u'pips3 Documentation',
      author,
-     's3pkgup',
+     'pips3',
      'One line description of project.',
      'Miscellaneous'),
 ]
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,4 @@
-Welcome to s3pkgup's documentation!
+Welcome to pips3's documentation!
 ============================================================
 
 .. toctree::

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -8,13 +8,13 @@ Installation
 Stable release
 --------------
 
-To install s3pkgup, run this command in your terminal:
+To install pips3, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install s3pkgup
+    $ pip install pips3
 
-This is the preferred method to install s3pkgup, as it will always install the most recent stable release.
+This is the preferred method to install pips3, as it will always install the most recent stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
@@ -26,19 +26,19 @@ you through the process.
 From sources
 ------------
 
-The sources for s3pkgup can be downloaded from the `Bitbucket repo`_.
+The sources for pips3 can be downloaded from the `Bitbucket repo`_.
 
 You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://bitbucket.org/harrison-ai/s3pkgup
+    $ git clone git://bitbucket.org/harrison-ai/pips3
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl -OJL https://bitbucket.org/harrison-ai/s3pkgup/downloads
+    $ curl -OJL https://bitbucket.org/harrison-ai/pips3/downloads
 
 Once you have a copy of the source, you can install it with:
 
@@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
     $ python setup.py install
 
 
-.. _Bitbucket repo: https://bitbucket.org/harrison-ai/s3pkgup
-.. _tarball: https://bitbucket.org/harrison-ai/s3pkgup/downloads
+.. _Bitbucket repo: https://bitbucket.org/harrison-ai/pips3
+.. _tarball: https://bitbucket.org/harrison-ai/pips3/downloads
diff --git a/docs/make.bat b/docs/make.bat
@@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
 )
 set SOURCEDIR=.
 set BUILDDIR=_build
-set SPHINXPROJ=s3pkgup
+set SPHINXPROJ=pips3
 
 if "%1" == "" goto help
 

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,6 +2,6 @@
 Usage
 =====
 
-To use s3pkgup in a project::
+To use pips3 in a project::
 
-    import s3pkgup
+    import pips3
diff --git a/pips3/__init__.py b/pips3/__init__.py
@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+"""Top-level package for pips3."""
+
+__author__ = """Ben Johnston"""
+__email__ = 'ben.johnston@annalise.ai'
+
+from ._version import get_versions
+
+__version__ = get_versions()['version']
+del get_versions
+
+from pips3.base import PipS3, publish_packages
diff --git a/s3pkgup/_version.py → pips3/_version.py b/s3pkgup/_version.py → pips3/_version.py