joe 0.0.7

.. figure:: http://i.imgur.com/y8g506n.png?1
:alt:

joe
===

A ``.gitignore`` magician in your command line. Joe generates
``.gitignore`` files from the command line for you.

.. figure:: http://i.imgur.com/ghmJLUP.gif
:alt:

Features
--------

- Written in uncomplicated Python
- Easy to `install <https://github.com/karan/joe#installation>`__
- Stupidly `easy to use <https://github.com/karan/joe#usage>`__
- Supports all Github-supported ```.gitignore``
files <https://github.com/karan/joe#list-all-available-files>`__
- Works on Mac, Linux and Windows
- Supports other version control systems (``.hgignore``)

Installation
------------

Option 1: Homebrew
~~~~~~~~~~~~~~~~~~

.. code:: bash

$brewupdate$ brew tap karan/karan
$\text{Missing open brace for subscript}$ pip install joe

Option 3: From source
~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

$gitclone--recursivegit@github.com:karan/joe.git$ cd joe/
$pythonsetup.pyinstallUsage-----Afterinstall,makesuretorun‘‘joeupdate‘‘.Thiswilldownloadall‘‘.gitignore‘‘filesin‘‘/joe-data/‘‘folder.Basicusage..code::bash$ joe java # outputs .gitignore file for java to stdout

To update your ``.gitignore`` files at any time, simply run:

.. code:: bash

$joeupdateOverwriteexisting‘‘.gitignore‘‘file..code::bash$ joe java > .gitignore # saves a new .gitignore file for java

Append to existing ``.gitignore`` file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

$\text{You can't use 'macro parameter character \#' in math mode}$ joe java node osx > .gitignore # saves a new .gitignore file for multiple languages

Create and append to a global .gitignore file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also use joe to append to a global .gitignore. These can be
helpful when you want to ignore files generated by an IDE, OS, or
otherwise.

.. code:: bash

$\text{You can't use 'macro parameter character \#' in math mode}$ joe OSX SublimeText >> ~/.gitignore

List all available files
~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

$\text{You can't use 'macro parameter character \#' in math mode}$ joe java > .hgignore

Contributing
------------

Bug Reports & Feature Requests
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Please use the `issue tracker <https://github.com/karan/joe/issues>`__
to report any bugs or file feature requests.

Developing
^^^^^^^^^^

PRs are welcome. To begin developing, do this:

.. code:: bash

# make virtual env
$gitclone--recursivegit@github.com:karan/joe.git$ cd joe/
$\text{Missing open brace for superscript}$ tool.sh [-h|--help] COMMAND

EXAMPLES:
$tool.shreadmeGenerateREADME.rstfromREADME.md$ tool.sh test Upload release to testpypi
$ tool.sh prod Upload release to prod pypi

Make sure you have a file ``.pypirc`` in ``~/`` in the following format:

::

[distutils]
index-servers =
pypi
pypitest

[pypi]
repository: https://pypi.python.org/pypi
username: <<>>
password: <<>>

[pypitest]
repository: https://testpypi.python.org/pypi
username: <<>>
password: <<>>