Skip to content

Commit

Permalink
First commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
dgilland committed May 27, 2015
0 parents commit d7c51db
Show file tree
Hide file tree
Showing 30 changed files with 1,550 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
*.py[cod]

# C extensions
*.so

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

# Installer logs
pip-log.txt

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

# Translations
*.mo

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

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

# Sphinx
docs/_build

# virtualenv
/env*
21 changes: 21 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Config file for automatic testing at travis-ci.org

language: python

python:
- "2.7"
- "3.3"
- "3.4"

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

# command to run tests, e.g. python setup.py test
script:
- make travisci-test

# tasks to execute after successful test
after_success:
- pip install python-coveralls --use-mirrors
- coveralls
14 changes: 14 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Authors
=======


Lead
----

- Derrick Gilland, [email protected], `dgilland@github <https://github.com/dgilland>`_


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

None
10 changes: 10 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _changelog:

Changelog
=========


v0.0.0 (xxxx-xx-xx)
-------------------

- First release.
196 changes: 196 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
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/dgilland/shed/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 "enhancement" or "help wanted" is open to whoever wants to implement it.


Write Documentation
+++++++++++++++++++

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

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

$ git clone [email protected]:your_name_here/shed.git

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

$ cd shed
$ make build

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 linting (`PEP8`_ and pylint) and the tests, including testing other Python versions with tox::

$ make test-full

6. Add yourself to ``AUTHORS.rst``.

7. 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

8. 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 README.rst.
3. The pull request should work for Python 2.7, 3.3, and 3.4. Check https://travis-ci.org/dgilland/shed/pull_requests and make sure that the tests pass for all supported Python versions.


Project CLI
-----------

Some useful CLI commands when working on the project are below. **NOTE:** All commands are run from the root of the project and require ``make``.

make build
++++++++++

Run the ``clean`` and ``install`` commands.

::

make build


make install
++++++++++++

Install Python dependencies into virtualenv located at ``env/``.

::

make install


make clean
++++++++++

Remove build/test related temporary files like ``env/``, ``.tox``, ``.coverage``, and ``__pycache__``.

::

make clean


make test
+++++++++

Run unittests under the virtualenv's default Python version. Does not test all support Python versions. To test all supported versions, see `make test-full`_.

::

make test


make test-full
++++++++++++++

Run unittest and linting for all supported Python versions. **NOTE:** This will fail if you do not have all Python versions installed on your system. If you are on an Ubuntu based system, the `Dead Snakes PPA`_ is a good resource for easily installing multiple Python versions. If for whatever reason you're unable to have all Python versions on your development machine, note that Travis-CI will run full integration tests on all pull requests.

::

make test-full


make lint
+++++++++

Run ``make pylint`` and ``make pep8`` commands.

::

make lint


make pylint
+++++++++++

Run ``pylint`` compliance check on code base.

::

make pylint


make pep8
+++++++++

Run `PEP8`_ compliance check on code base.

::

make pep8


make docs
+++++++++

Build documentation to ``docs/_build/``.

::

make docs


.. _Dead Snakes PPA: https://launchpad.net/~fkrull/+archive/deadsnakes
.. _PEP8: http://legacy.python.org/dev/peps/pep-0008/
24 changes: 24 additions & 0 deletions LICENSE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
License
=======

The MIT License (MIT)

Copyright (c) 2015, Derrick Gilland

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 the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
11 changes: 11 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
include AUTHORS.rst
include CONTRIBUTING.rst
include CHANGES.rst
include LICENSE.rst
include README.rst

recursive-include tests *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]

recursive-include docs *.rst conf.py Makefile make.bat
Loading

0 comments on commit d7c51db

Please sign in to comment.