-m DME-3 building a better python package

Author: oscarmcm

.coverage

@@ -3,3 +3,5 @@
 dist/
 magicembed.egg-info/
 build
+.tox
+django_magicembed.egg-info

.gitignore

@@ -0,0 +1,31 @@
+language: python
+
+python:
+    - "2.7"
+    - "3.4"
+
+env:
+    - DJANGO=django==1.4.*
+    - DJANGO=django==1.5.*
+    - DJANGO=django==1.6.*
+    - DJANGO=django==1.7.*
+    - DJANGO=django==1.8.*
+
+install: 
+    - pip install -r test_requirements.txt --use-mirrors
+    - pip install $DJANGO
+    - pip install coveralls
+
+script:
+    - cd magicembed/tests
+    - ./runtests.py
+    - mv .coverage ../../
+    - cd ../../
+
+matrix:
+    exclude:
+        - python: "3.4"
+          env: DJANGO=django==1.4.*
+
+after_success: 
+    - coveralls

.travis.yml

@@ -0,0 +1,7 @@
+Current or previous core committers
+
+Adolfo Fitoria
+Andres Reyes
+Oscar Cortez
+
+* Your name could stand here :)

AUTHORS

@@ -0,0 +1,18 @@
+=== 0.0.X (onggoing, to be released as 0.1) ===
+- Initial commit
+
+
+# Suggested file syntax:
+#
+# === (ongoing) ===
+# - this is always on top of the file
+# - when you release a new version, you rename the last `(ongoing)` to the new
+#   version and add a new `=== (ongoing) ===` to the top of the file
+#
+# === 1.0 ===
+# - a major version is created when the software reached a milestone and is 
+#   feature complete
+#
+# === 0.2 ===
+# - a minor version is created when a lot of new features have bene added or
+#   significant backwards incompatible changes have been made.

CHANGELOG.txt

@@ -0,0 +1 @@
+An easy and simple Django template tag and tool to embed video and get thumbnails from video providers.

DESCRIPTION

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2015 Adolfo Fitoria
+Copyright (c) 2015 Adolfo Fitoria 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

LICENSE

@@ -0,0 +1,11 @@
+include AUTHORS
+include LICENSE
+include DESCRIPTION
+include CHANGELOG.txt
+include README.md
+include tox.ini
+include requirements.txt
+graft magicembed
+global-exclude *.orig *.pyc *.log *.swp local_settings.py
+prune magicembed/tests/coverage
+prune magicembed/.ropeproject

MANIFEST.in

@@ -0,0 +1,13 @@
+develop: setup-git
+	pip install "file://`pwd`#egg=magicembed[dev]"
+	pip install -e .
+	pip install -r test_requirements.txt
+
+setup-git:
+	git config branch.autosetuprebase always
+	cd .git/hooks && ln -sf hooks/* ./
+
+lint-python:
+	@echo "Linting Python files"
+	PYFLAKES_NODOCTEST=1 flake8 magicembed
+	@echo ""

Makefile

@@ -39,6 +39,17 @@ When you have the API key, add this in your settings.py:
 How to install it?
 -------------------
 
+To get the latest stable release from PyPI
+
+.. code-block:: bash
+     pip install django-magicembed
+
+To get the latest commit from GitHub
+
+.. code-block:: bash
+
+    pip install -e git+git://github.com/kronoscode/django-magicembed.git#egg=magicembed
+
 If you have a requeriments list add this to your requeriments
 
 1. <code>magicembed==(version)</code>
@@ -47,16 +58,21 @@ If you have a requeriments list add this to your requeriments
 
 3. <code>add magicembed to **INSTALLED_APPS**</code>
 
-Or if you use setup.py
+.. code-block:: python
+     INSTALLED_APPS = (
+         ...,
+        'magicembed',
+     )
 
-1. run <code>python setup.py install</code>
 
 How to use
 ---------------
 
-First add this in the template to load the template tags
+Before your tags/filters are available in your templates, load them by using
+
+.. code-block:: html
 
-<code>{% load magicembed_tags %}</code>
+  {% load magicembed_tags %}
 
 Now if you need to embed a video, add this template tag to video url
 field
@@ -67,14 +83,33 @@ Or to get a thumbnail url
 
 <code>{{ video|magicthumbnail }}</code>
 
+Run magicembed test
+--------------------
+
+If you want run test please set in the test_settings.py your
+Embedly Api Key correctly
+
+In order to run the tests, simply execute ``tox``. This will install two new
+environments (for Django 1.6 and Django 1.7) and run the tests against both
+environments.
+
 How to contrib
 ----------------
 
-1. Fork it ( http://github.com/kronoscode/django-magicembed/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+If you want to contribute to this project, please perform the following steps
+
+.. code-block:: bash
+
+     # Fork this repository
+     # Clone your fork
+     mkvirtualenv -p python2.7 django-magicembed
+     make develop
+
+     git co -b feature_branch master
+     # Implement your feature and tests
+     git add . && git commit
+     git push -u origin feature_branch
+     # Send us a pull request for your feature branch
 
 Licence
 --------------