skeleton

Author: algrs

.gitignore

@@ -0,0 +1,106 @@
+
+# Created by https://www.gitignore.io/api/osx,python
+
+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask instance folder
+instance/
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# dotenv
+.env
+
+/bodylabs-python-style/

MANIFEST.in

@@ -0,0 +1,2 @@
+include requirements.txt
+include README.md

README.md

@@ -0,0 +1,86 @@
+skeleton-py
+===========
+
+A project starter for Body Labs Python projects.
+
+To use this skeleton:
+
+1. Clone the skeleton:
+
+        git clone [email protected]:bodylabs/template-py.git my-library
+
+2. Re-initialize the git repository:
+
+        cd my-library && rm -rf .git && git init
+
+3. Publish the license, or delete it, depending whether or not the project is
+   open source:
+
+        mv RENAME-TO-LICENSE-IF-PUBLIC-ELSE-DELETE LICENSE
+        rm RENAME-TO-LICENSE-IF-PUBLIC-ELSE-DELETE
+
+4. Commit the changed files.
+
+        git add . && git commit -m "Project skeleton"
+
+5. Make updates as needed.
+
+
+- - - - - - - - - - - - -
+
+example
+=======
+
+Short description of the module.
+
+
+Features
+--------
+
+- This
+- That
+- The other
+
+
+Examples
+--------
+
+```py
+from example.hello import hello
+hello()
+```
+
+```sh
+hello
+```
+
+
+Development
+-----------
+
+```sh
+pip install -r requirements_dev.txt
+rake test
+rake lint
+```
+
+
+Contribute
+----------
+
+- Issue Tracker: github.com/bodylabs/example/issues
+- Source Code: github.com/bodylabs/example
+
+Pull requests welcome!
+
+
+Support
+-------
+
+If you are having issues, please let us know.
+
+
+License
+-------
+
+The project is licensed under the two-clause BSD license.

RENAME-TO-LICENSE-IF-PUBLIC-ELSE-DELETE

@@ -0,0 +1,23 @@
+Copyright (c) 2016, Body Labs, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Rakefile

@@ -0,0 +1,70 @@
+$style_config_version = '1.0.1'
+
+desc "Install style config"
+task :install_style_config do
+  FileUtils.rm_rf "bodylabs-python-style" if Dir.exists? "bodylabs-python-style"
+  raise unless system "git clone https://github.com/bodylabs/bodylabs-python-style.git"
+  Dir.chdir 'bodylabs-python-style' do
+    raise unless system "git checkout tags/#{$style_config_version}"
+  end
+end
+
+task :require_style_config do
+  Rake::Task[:install_style_config].invoke unless File.executable? 'bodylabs-python-style/bin/pylint_test'
+end
+
+$mac_os = `uname -s`.strip == 'Darwin'
+
+desc "Install dependencies for distribution"
+task :install_dist do
+  if $mac_os
+    raise unless system "brew update"
+    raise unless system "brew install pandoc"
+    raise unless system "pip install pypandoc"
+  else
+    puts
+    puts "You must install:"
+    puts
+    puts " - pandoc"
+    puts " - pypandoc"
+    puts
+    raise
+  end
+end
+
+def command_is_in_path?(command)
+  system("which #{ command} > /dev/null 2>&1")
+end
+
+task :unittest do
+  raise unless system "nose2"
+end
+
+task :lint => :require_style_config do
+  raise unless system "bodylabs-python-style/bin/pylint_test example --min_rating 10.0"
+end
+
+desc "Remove .pyc files"
+task :clean do
+  system "find . -name '*.pyc' -delete"
+end
+
+task :sdist do
+  unless command_is_in_path? 'pandoc'
+    puts
+    puts "Please install pandoc."
+    puts
+    raise
+  end
+  raise unless system "python setup.py sdist"
+end
+
+task :upload do
+  unless command_is_in_path?('pandoc')
+    puts
+    puts "Please install pandoc."
+    puts
+    raise
+  end
+  raise unless system "python setup.py sdist upload"
+end

bin/hello

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+from example.hello import hello
+hello()

circle.yml

@@ -0,0 +1,18 @@
+general:
+  branches:
+    ignore:
+      - /zz.*/  # Don't run tests on deprecated branches.
+
+machine:
+  environment:
+    PYTHONPATH: /usr/local/lib/python2.7/dist-packages
+
+dependencies:
+  override: # Rather than using their autodetected steps, use these instead
+    - rake install_style_config
+    - pip install -r requirements_dev.txt
+
+test:
+  override: # rather than using their autodetected steps, use these instead
+    - rake unittest
+    - rake lint

example/__init__.py

@@ -0,0 +1 @@
+__version__ = '1.0.0'

example/hello.py

@@ -0,0 +1,3 @@
+def hello():
+    from example.resources.constants import WELCOME_MESSAGE
+    print WELCOME_MESSAGE

example/resources/__init__.py

@@ -0,0 +1 @@
+WELCOME_MESSAGE = 'Hello world'

example/resources/constants.py

@@ -0,0 +1,7 @@
+import unittest
+
+class TestHello(unittest.TestCase):
+
+    def test_hello_runs(self):
+        from example.hello import hello
+        hello()

example/test_hello.py

@@ -0,0 +1,4 @@
+-r requirements.txt
+
+nose2==0.5.0
+pylint==1.5.4

requirements.txt

@@ -0,0 +1,42 @@
+# Conversion from Markdown to pypi's restructured text: https://coderwall.com/p/qawuyq -- Thanks James.
+
+try:
+    import pypandoc
+    long_description = pypandoc.convert('README.md', 'rst')
+except (IOError, ImportError):
+    long_description = ''
+    print 'warning: pandoc or pypandoc does not seem to be installed; using empty long_description'
+
+import importlib
+from pip.req import parse_requirements
+from setuptools import setup
+
+install_requires = parse_requirements('requirements.txt', session=False)
+install_requires = [str(ir.req) for ir in install_requires]
+
+setup(
+    name='example',
+    version=importlib.import_module('example').__version__,
+    author='Body Labs',
+    author_email='[email protected]',
+    description='___',
+    long_description=long_description,
+    url='https://github.com/bodylabs/___',
+    license='MIT',
+    packages=[
+        'example',
+        'example/util',
+    ],
+    scripts=[
+        'bin/hello',
+    ],
+    install_requires=install_requires,
+    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+    ]
+)