Skip to content

Commit

Permalink
Move to testing+docs standard package structure
Browse files Browse the repository at this point in the history
  • Loading branch information
bennylope committed Jan 26, 2014
1 parent a88f981 commit 4bfd8cd
Show file tree
Hide file tree
Showing 25 changed files with 1,047 additions and 30 deletions.
44 changes: 40 additions & 4 deletions .gitignore
@@ -1,6 +1,42 @@
*.pyc
build/
dist/
*.py[cod]

# C extensions
*.so

# Packages
*.egg
*.egg-info
dist
build
eggs
parts
bin
var
sdist
develop-eggs
.installed.cfg
lib
lib64

# Installer logs
pip-log.txt

# Unit test / coverage reports
.coverage
.tox
nosetests.xml

# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject

# Complexity
output/*.html
output/*/index.html

# Sphinx
docs/_build
*.sqlite
17 changes: 17 additions & 0 deletions .travis.yml
@@ -0,0 +1,17 @@
# Config file for automatic testing at travis-ci.org

language: python

python:
- "3.3"
- "2.7"
- "2.6"

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

# command to run tests using coverage, e.g. python setup.py test
script: coverage run --source elasticstack runtests.py

# report coverage to coveralls.io
after_success: coveralls
15 changes: 12 additions & 3 deletions AUTHORS.rst
@@ -1,4 +1,13 @@
Primary developers and contributors
=======
Credits
=======

Ben Lopatin @bennylope
Basil Shubin @bashu
Development Lead
----------------

* Ben Lopatin @bennylope

Contributors
------------

* Basil Shubin @bashu
112 changes: 112 additions & 0 deletions CONTRIBUTING.rst
@@ -0,0 +1,112 @@
============
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/bennylope/elasticstack/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
~~~~~~~~~~~~~~~~~~~

elasticstack could always use more documentation, whether as part of the
official elasticstack 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/bennylope/elasticstack/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 `elasticstack` for local development.

1. Fork the `elasticstack` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/elasticstack.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 elasticstack
$ cd elasticstack/
$ 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 elasticstack 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, and 3.3, and for PyPy. Check
https://travis-ci.org/bennylope/elasticstack/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_elasticstack
9 changes: 9 additions & 0 deletions HISTORY.rst
@@ -0,0 +1,9 @@
.. :changelog:
History
-------

0.1.0 (2013-10-04)
++++++++++++++++++

* First release on PyPI.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,4 +1,4 @@
Copyright (c) 2013, Ben Lopatin
Copyright (c) 2014, Ben Lopatin
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
7 changes: 6 additions & 1 deletion MANIFEST.in
@@ -1 +1,6 @@
include setup.py README.rst MANIFEST.in LICENSE
include AUTHORS.rst
include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst
recursive-include elasticstack *.html *.png *.gif *js *jpg *jpeg *svg *py

0 comments on commit 4bfd8cd

Please sign in to comment.