Skip to content

Commit

Permalink
Add a README.rst to satisfy PyPI
Browse files Browse the repository at this point in the history
Because pandoc is even more nuts than ReST.
  • Loading branch information
grampajoe committed Feb 15, 2015
1 parent 95ed2d8 commit 42e252c
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions README.rst
@@ -0,0 +1,69 @@
happy
=====

.. image:: https://img.shields.io/travis/grampajoe/happy.svg
:target: https://travis-ci.org/grampajoe/happy
.. image:: https://img.shields.io/coveralls/grampajoe/happy.svg
:target: https://coveralls.io/r/grampajoe/happy
.. image:: https://img.shields.io/scrutinizer/g/grampajoe/happy.svg
:target: https://scrutinizer-ci.com/g/grampajoe/happy/

Quickly set up and tear down Heroku apps!

Note: This doesn't work yet! I'm just getting it started!!!!!!!!!
(Don't use it.)

Quickly starting
----------------

Add an `app.json manifest`_
that looks kinda like this:

.. code:: json
{
"name": "My App Thing",
"repository": "https://github.com/helloitsme/thingy",
"env": {
"FROBULATION_LIMIT": {
"description": "Maximum frobulations per lunar cycle.",
"value": "7"
}
},
"addons": [
"pusher"
]
}
Push that to your thing's ``master`` branch on GitHub so Heroku can find it.

Log in with the `Heroku toolbelt`_ , then do this:

.. code:: text
$ pip install happy
$ happy up
Creating app...
It's up! :) https://butt-man-123.herokuapp.com
That's it! You made a temporary app with all the fixins, which you can
use to continuously integrate or whatever you want to do.

Then, you can get rid of it like:

.. code:: text
$ happy down
Destroying app...
It's down. :(
.. _app.json manifest: https://devcenter.heroku.com/articles/app-json-schema
.. _Heroku toolbelt: https://toolbelt.heroku.com/

Running the tests
-----------------

1. Install tox_ with ``pip install tox``.
2. Run the tests with ``tox``.

.. _tox: https://tox.readthedocs.org

0 comments on commit 42e252c

Please sign in to comment.