Merge pull request #2 from martinohanlon/dev

v1.1

.gitignore

@@ -1,215 +1,33 @@
-#################
-## Eclipse
-#################
+*.py[cdo]
+pythonhosted/
 
-*.pydevproject
-.project
-.metadata
-bin/
-tmp/
-*.tmp
-*.bak
+# Editor detritus
+*.vim
 *.swp
-*~.nib
-local.properties
-.classpath
-.settings/
-.loadpath
+tags
+.vscode
 
-# External tool builders
-.externalToolBuilders/
-
-# Locally stored "Eclipse launch configurations"
-*.launch
-
-# CDT-specific
-.cproject
-
-# PDT-specific
-.buildpath
-
-
-#################
-## Visual Studio
-#################
-
-## Ignore Visual Studio temporary files, build results, and
-## files generated by popular Visual Studio add-ons.
-
-# User-specific files
-*.suo
-*.user
-*.sln.docstates
-
-# Build results
-
-[Dd]ebug/
-[Rr]elease/
-x64/
-build/
-[Bb]in/
-[Oo]bj/
-
-# MSTest test Results
-[Tt]est[Rr]esult*/
-[Bb]uild[Ll]og.*
-
-*_i.c
-*_p.c
-*.ilk
-*.meta
-*.obj
-*.pch
-*.pdb
-*.pgc
-*.pgd
-*.rsp
-*.sbr
-*.tlb
-*.tli
-*.tlh
-*.tmp
-*.tmp_proj
-*.log
-*.vspscc
-*.vssscc
-.builds
-*.pidb
-*.log
-*.scc
-
-# Visual C++ cache files
-ipch/
-*.aps
-*.ncb
-*.opensdf
-*.sdf
-*.cachefile
-
-# Visual Studio profiler
-*.psess
-*.vsp
-*.vspx
-
-# Guidance Automation Toolkit
-*.gpState
-
-# ReSharper is a .NET coding add-in
-_ReSharper*/
-*.[Rr]e[Ss]harper
-
-# TeamCity is a build add-in
-_TeamCity*
-
-# DotCover is a Code Coverage Tool
-*.dotCover
-
-# NCrunch
-*.ncrunch*
-.*crunch*.local.xml
-
-# Installshield output folder
-[Ee]xpress/
-
-# DocProject is a documentation generator add-in
-DocProject/buildhelp/
-DocProject/Help/*.HxT
-DocProject/Help/*.HxC
-DocProject/Help/*.hhc
-DocProject/Help/*.hhk
-DocProject/Help/*.hhp
-DocProject/Help/Html2
-DocProject/Help/html
-
-# Click-Once directory
-publish/
-
-# Publish Web Output
-*.Publish.xml
-*.pubxml
-
-# NuGet Packages Directory
-## TODO: If you have NuGet Package Restore enabled, uncomment the next line
-#packages/
-
-# Windows Azure Build Output
-csx
-*.build.csdef
-
-# Windows Store app package directory
-AppPackages/
-
-# Others
-sql/
-*.Cache
-ClientBin/
-[Ss]tyle[Cc]op.*
-~$*
-*~
-*.dbmdl
-*.[Pp]ublish.xml
-*.pfx
-*.publishsettings
-
-# RIA/Silverlight projects
-Generated_Code/
-
-# Backup & report files from converting an old project file to a newer
-# Visual Studio version. Backup files are not needed, because we have git ;-)
-_UpgradeReport_Files/
-Backup*/
-UpgradeLog*.XML
-UpgradeLog*.htm
-
-# SQL Server files
-App_Data/*.mdf
-App_Data/*.ldf
-
-#############
-## Windows detritus
-#############
-
-# Windows image file caches
-Thumbs.db
-ehthumbs.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Mac crap
-.DS_Store
-
-
-#############
-## Python
-#############
-
-*.py[co]
-
-# Packages
+# Packaging detritus
 *.egg
 *.egg-info
-dist/
-build/
-eggs/
-parts/
-var/
-sdist/
-develop-eggs/
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
 .installed.cfg
 
 # Installer logs
 pip-log.txt
 
 # Unit test / coverage reports
+coverage
 .coverage
 .tox
+.cache
 
-#Translations
-*.mo
-
-#Mr Developer
-.mr.developer.cfg
+# Generated documentation
+docs/_build

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+## 2018-05-01 v1.1.0 
+
++ packaged and released onto [PyPI](https://pypi.org)
++ it seemed ridiculous calling this v1.0.0 given the maturity of this library, so it has become v1.1.0
+
+## in the past v1.0.0
+
++ the library was created it was used but never packaged.

README.md

@@ -1,18 +1,46 @@
-# Minecraft: Pi edition API Python Library, with my add-ons
+# Minecraft: Pi edition API Python Library
 
-Martin O'Hanlon
+`mcpi` Python library for communicating with [Minecraft: Pi edition](https://minecraft.net/en-us/edition/pi/) and [RaspberryJuice](https://github.com/zhuowei/RaspberryJuice).
 
-## Sources
+## Installation
 
-This library is a collection of the following sources
+### Windows
 
-[Python 3 Minecraft: Pi edition library](https://github.com/py3minepi/py3minepi)
+```
+pip3 install mcpi
+```
 
-[minecraftstuff](https://github.com/martinohanlon/minecraft-stuff)
+### Linux / MacOS
 
-## Licenses
+```bash
+sudo pip3 install mcpi
+```
+
+## History
+
+The [Minecraft: Pi edition](https://minecraft.net/en-us/edition/pi/) Python library was originally created by Mojang and released with Minecraft: Pi edition.
+
+Initial supported was provided for Python 2 only, but during a sprint at PyconUK 2014 it was migrated to Python 3 and [py3minepi](https://github.com/py3minepi/py3minepi) was created.
+
+The ability to hack Minecraft from Python was very popular and the [RaspberryJuice](https://github.com/zhuowei/RaspberryJuice) plugin was created for Minecraft Java edition. RaspberryJuice also extended the API adding additional features.
+
+This python library supports Python 2 & 3 and Minecraft: Pi edition and RaspberryJuice.
+
+Documentation for the Minecraft: Pi edition and RaspberryJuice API's can be found at [www.stuffaboutcode.com/p/minecraft-api-reference.html](http://www.stuffaboutcode.com/p/minecraft-api-reference.html).
 
-Minecraft: Pi edition LICENSE - [minecraft-pi-edition-LICENSE.txt](https://github.com/martinohanlon/mcpi/blob/master/mcpi/minecraft-pi-edition-LICENSE.txt)
+It was released onto [PyPI](https://pypi.org) in May 2018.
+
+If you want some cool additional tools for modifying Minecraft, check out [minecraft-stuff](https://minecraft-stuff.readthedocs.io/en/latest/).
+
+## Sources
+
+This library is a collection of the following sources:
+
++ [Minecraft: Pi edition](https://minecraft.net/en-us/edition/pi/)
++ [Python 3 Minecraft: Pi edition library](https://github.com/py3minepi/py3minepi)
+
+## Licenses
 
-minecraftstuff LICENSE - [minecraft-stuff-LICENSE](https://github.com/martinohanlon/mcpi/blob/master/mcpi/minecraft-stuff-LICENSE)
++ mcpi - [LICENSE.txt](https://github.com/martinohanlon/mcpi/blob/master/LICENSE)
++ Minecraft: Pi edition LICENSE - [minecraft-pi-edition-LICENSE.txt](https://github.com/martinohanlon/mcpi/blob/master/minecraft-pi-edition-LICENSE.txt)