Added many of the files.

# http://editorconfig.org

root = true

[*]

indent_style = space

indent_size = 4

trim_trailing_whitespace = true

insert_final_newline = true

charset = utf-8

end_of_line = lf

[*.bat]

indent_style = tab

end_of_line = crlf

[LICENSE]

insert_final_newline = false

[Makefile]

indent_style = tab

# Config file for automatic testing at travis-ci.org

# This file will be regenerated if you run travis_pypi_setup.py

language: python

python: 3.5

env:

  - TOXENV=py35

  - TOXENV=py34

  - TOXENV=py33

  - TOXENV=py27

  - TOXENV=py26

  - TOXENV=pypy

# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors

install: pip install -U tox

# command to run tests, e.g. python setup.py test

script: tox

# After you create the Github repo and add it to Travis, run the

# travis_pypi_setup.py script to finish PyPI deployment setup

deploy:

  provider: pypi

  distributions: sdist bdist_wheel

  user: transientlunatic

  password:

    secure: PLEASE_REPLACE_ME

  on:

    tags: true

    repo: transientlunatic/minki

    condition: $TOXENV == py27

=======

Credits

=======

Development Lead

----------------

* Daniel Williams <d.williams.2@research.gla.ac.uk>

Contributors

------------

None yet. Why not be the first?

.. highlight:: shell

============

Contributing

============

Contributions are welcome, and they are greatly appreciated! Every

little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

----------------------

Report Bugs

~~~~~~~~~~~

Report bugs at https://github.com/transientlunatic/minki/issues.

If you are reporting a bug, please include:

* Your operating system name and version.

* Any details about your local setup that might be helpful in troubleshooting.

* Detailed steps to reproduce the bug.

Fix Bugs

~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug"

is open to whoever wants to implement it.

Implement Features

~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "feature"

is open to whoever wants to implement it.

Write Documentation

~~~~~~~~~~~~~~~~~~~

Minki: The Burst MDC Factory could always use more documentation, whether as part of the

official Minki: The Burst MDC Factory docs, in docstrings, or even on the web in blog posts,

articles, and such.

Submit Feedback

~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/transientlunatic/minki/issues.

If you are proposing a feature:

* Explain in detail how it would work.

* Keep the scope as narrow as possible, to make it easier to implement.

* Remember that this is a volunteer-driven project, and that contributions

  are welcome :)

Get Started!

------------

Ready to contribute? Here's how to set up `minki` for local development.

1. Fork the `minki` repo on GitHub.

2. Clone your fork locally::

    $ git clone git@github.com:your_name_here/minki.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

    $ mkvirtualenv minki

    $ cd minki/

    $ python setup.py develop

4. Create a branch for local development::

    $ git checkout -b name-of-your-bugfix-or-feature

   Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::

    $ flake8 minki tests

    $ python setup.py test

    $ tox

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub::

    $ git add .

    $ git commit -m "Your detailed description of your changes."

    $ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

-----------------------

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.

2. If the pull request adds functionality, the docs should be updated. Put

   your new functionality into a function with a docstring, and add the

   feature to the list in README.rst.

3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check

   https://travis-ci.org/transientlunatic/minki/pull_requests

   and make sure that the tests pass for all supported Python versions.

Tips

----

To run a subset of tests::

    $ python -m unittest tests.test_minki

=======

History

=======

0.1.0 (2016-3-14)

------------------

* First release on PyPI.