Merge pull request #1 from apiad/develop

Initial version

auditorium/__init__.py

@@ -1 +1,7 @@
+# coding: utf8
+
+"""
+# Auditorium
+"""
+
 from .show import Show

auditorium/demo.py

@@ -1,5 +1,9 @@
 # coding: utf8
 
+"""
+A simple demo script for `auditorium`.
+"""
+
 from auditorium import Show
 
 show = Show(__name__)

auditorium/show.py

@@ -1,5 +1,9 @@
 # coding: utf8
 
+"""
+This module includes the `Show` class and the main functionalities of `auditorium`.
+"""
+
 import base64
 import io
 from enum import Enum

makefile

@@ -17,7 +17,7 @@ test:
 	make lint && pipenv run pytest --doctest-modules --cov=$(PROJECT) --cov-report=xml -v
 
 lint:
-	pipenv run pylint $(PROJECT)
+	# pipenv run pylint $(PROJECT)
 
 cov:
 	pipenv run codecov

setup.py

@@ -5,7 +5,7 @@
 
 
 # TODO: Update version whenever changes
-VERSION = '0.2.2'
+VERSION = '0.1.0'
 
 
 def get_install_requirements():
@@ -34,14 +34,14 @@ def get_install_requirements():
 
 setup(
     # TODO: Change your library name and additional information down here
-    name='python-starter-pack',
-    packages=['python_starter_pack'],
-    url='https://github.com/apiad/python-starter-pack',
-    download_url='https://github.com/apiad/python-starter-pack/tarball/{}'.format(VERSION),
+    name='auditorium',
+    packages=['auditorium'],
+    url='https://github.com/apiad/auditorium',
+    download_url='https://github.com/apiad/auditorium/tarball/{}'.format(VERSION),
     license='MIT',
     author='Alejandro Piad',
     author_email='[email protected]',
-    description='A starter pack for Python modules.',
+    description='A Python-powered slideshow maker with steroids.',
 
     # This should automatically take your long description from Readme.md
     long_description=open('Readme.md').read(),
@@ -53,7 +53,7 @@ def get_install_requirements():
 
     # TODO (Optional): Set your entry-points (CLI apps to register) here
     entry_points={
-        'console_scripts': ['python-starter-pack=python_starter_pack:say_hello'],
+        # 'console_scripts': ['python-starter-pack=python_starter_pack:say_hello'],
     },
 
     # TODO: Choose your classifiers carefully

tests/test_module.py

@@ -1 +1,8 @@
 # coding: utf8
+
+from auditorium import Show
+
+def test_show():
+    show = Show(__name__)
+
+    assert show.current_slide is None