initial commit

+ PyPi and TravisCI configs
+ unittest tests, notebook and doc starters

Author: json2d

.gitattributes

@@ -0,0 +1 @@
+*.ipynb linguist-detectable=false

.gitignore

@@ -1,3 +1,5 @@
+.vscode
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.travis.yml

@@ -0,0 +1,22 @@
+language: python
+python:
+  # - "3.5"
+  - "3.6"      # current default Python on Travis CI
+  - "3.7"
+  - "3.8"
+  - "3.8-dev"  # 3.8 development branch
+# command to install dependencies
+install:
+  - pip install -r requirements.tests.txt -r requirements.txt
+  - pip install coveralls
+# command to run tests and generate coverage report
+script:
+  - coverage run tests/units.py
+# send coverage report to coveralls.io service
+after_success:
+  - coveralls
+branches:
+  only:
+  - master
+  - /^release\/.*$/
+  - /^hotfix\/.*$/

NEXT.ipynb

@@ -0,0 +1,67 @@
+{
+ "nbformat": 4,
+ "nbformat_minor": 2,
+ "metadata": {
+  "language_info": {
+   "name": "python",
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "version": "3.6.8-final"
+  },
+  "orig_nbformat": 2,
+  "file_extension": ".py",
+  "mimetype": "text/x-python",
+  "name": "python",
+  "npconvert_exporter": "python",
+  "pygments_lexer": "ipython3",
+  "version": 3,
+  "kernelspec": {
+   "name": "python36832bitvenvvenvb93cf92d5fe6482d9f0b0a9d194e1425",
+   "display_name": "Python 3.6.8 32-bit ('.venv': venv)"
+  }
+ },
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%load_ext autoreload\n",
+    "\n",
+    "%autoreload 2"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "logging.basicConfig(level=logging.INFO)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import pything as pyt\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pyt.do_stuff()\n",
+    "pyt.do_crazier_stuff()\n"
+   ]
+  }
+ ]
+}

NEXT.md

@@ -0,0 +1,4 @@
+# Whats next
+
+> ### Disclaimer 
+> The contents of this file is a fairly coherent stream of conscience brainstorm about different direction to take the design of this library, and intended to be documentation with accurate code examples that reflect how you would actually use the library. For that refer to `README.md`

README.md

@@ -1,2 +1,34 @@
-# pything
+# 🐍 pything
+[![PyPI version](https://badge.fury.io/py/pything.svg)](https://badge.fury.io/py/pything)
+[![Build Status](https://travis-ci.com/json2d/pything.svg?branch=master)](https://travis-ci.com/json2d/pything) [![Coverage Status](https://coveralls.io/repos/github/json2d/pything/badge.svg?branch=master)](https://coveralls.io/github/json2d/pything?branch=master)
+
 a Python library starter template
+
+## Quick install
+```bash
+pip install pything
+```
+
+## Basic usage
+
+[decent pitch]. Let's dive in.
+
+Out-of-the-box you get some stuff you can do with a pything:
+
+```py
+import pything as pyt
+
+pyt.do_stuff()
+
+```
+
+## More advanced usage
+
+Then here's this stuff you can do with a pything:
+
+```py
+import pything as pyt
+
+pyt.do_crazier_stuff()
+
+```

deploy.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+python setup.py sdist
+twine upload dist/*

pything/__init__.py

@@ -0,0 +1 @@
+from .core import *

pything/core.py

@@ -0,0 +1,11 @@
+import logging
+log = logging.getLogger("[🐍pything]")
+log.addHandler(logging.NullHandler()) # ignore log messages by defualt
+
+def do_stuff():
+  print('...')
+  return 42
+
+def do_crazier_stuff():
+  print('...', 'hello world!')
+  return 42

requirements.jupyter.txt

@@ -0,0 +1 @@
+notebook