Skip to content

Commit

Permalink
Merge pull request #45 from /issues/44
Browse files Browse the repository at this point in the history
0.1.0 release
  • Loading branch information
jantman committed Jul 26, 2015
2 parents 76c7e51 + 7e456fd commit c5b0225
Show file tree
Hide file tree
Showing 77 changed files with 10,011 additions and 1,613 deletions.
3 changes: 2 additions & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ exclude_lines =
# this cant ever be run by py.test, but it just calls one function,
# so ignore it
if __name__ == .__main__.:
if sys.version_info\[.+
if sys.version_info.+
raise NotImplementedError
except ImportError:
6 changes: 2 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,12 @@ coverage.xml

# Sphinx documentation
docs/build/
docs/source/awslimitchecker*.rst
docs/source/modules.rst
docs/source/limits.rst
docs/source/iam_policy.rst

# PyBuilder
target/

# virtualenv
bin/
include/

.idea/
7 changes: 7 additions & 0 deletions .landscape.yaml
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
doc-warnings: true
strictness: medium
test-warnings: false
pylint:
disable:
- protected-access
ignore-paths:
- awslimitchecker/services/__init__.py
27 changes: 19 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,21 @@ cache:
- $HOME/.pip-cache/

env:
- TOXENV=py26 PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py27 PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py32 PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py33 PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py34 PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py26-unit PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py27-unit PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py32-unit PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py33-unit PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py34-unit PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=pypy-unit PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=pypy3-unit PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py26-integration PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py27-integration PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py32-integration PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py33-integration PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=py34-integration PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=pypy-integration PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=pypy3-integration PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=docs PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=pypy PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=pypy3 PIP_DOWNLOAD_CACHE=$HOME/.pip-cache
- TOXENV=cov PIP_DOWNLOAD_CACHE=$HOME/.pip-cache

install:
Expand All @@ -33,7 +40,11 @@ notifications:
email:
on_success: always
on_failure: always

pushover:
users:
- secure: lJew7OKfWteJixOuxH+vfKIrIWzManoqQbDqG7xpB++LpsezWMoEIh+S4GqxWuRoxo8F5wJZuNTAvyyu5p2C3DIMbYvoy5PFYvAhMB7wkPesT03zUMMFGFDNdIOTfArt0yWyTtEBm5dcwhxe3kg9sq9nMY/3XcEGXkCO1vgR3/yUZByAZ6CJ27THEZ3B6QzLvDGAMT1lEC8iCUX+EwyCQRH+67a5WaI2F1is14JbGGLDzq2rTR3Tv0jH1wEXp2aLdPkqpZmw2T6URPYnv5QfOdzagMnAL3M33Nbmi3yTIaJal05oI6McaTFOX28QkwkLfPTUAj/eH66fzxV5JZlxvWk3ugoTSNGCBWMTzuIaTOAyauaisXM76Gth849M1XtoVu4gAAwdwd12UEUvtELNtWi1onwmhMTUdZ7HGNFggfMNZzs8Brd5S9+yZA7Fn1prU3DPb8GAEw8nOlgsdQZ8kDjpTlmvxdbeH7zb5+Yw8huxj2qvYsYFCfneFlO2TEnR+VwkcgiW8zjwQCYaT2ku0lWOjzVMQvaVyS4DXLl9P1PcDVgifUZr0caDFxDrFtEinML6WbO4kSSOyGRAbaHKWqI9Cu1g89HlcaLVNAzlnznChxHcpdLfxHstlnMuGUe0ejCi0ljj0ucMBRIEa63E3oteiFE+Mo5iNcDcnt/cBos=
api_key:
secure: mm7zd1jAIZO/FAVdxoH3Pref7OwReRbRUQq1l7/V16JBySAkCq6MRxQ0nN0/eOqDH0fu/BBMfRrvkYn/vFnR3Y+qGvp4QpCb1A8WY2WgfnF65wFpDxAbhJ3c37fwc+4o1VocaXke60zwbIXFA3pWThZAnMvxFsColos7IEbu8h/JAvz/L4mOIrKpmgBSdXeimhheYdJS/q7RvOUxkOqS/qbXhNNjxZImuMSu7vUS55ANy+BXQ4/2UdGeGeXS2j/Kzz+xC7XJ5ztp7v/U9CRPMahB8eFidgDQpoGLEBWYyIV2XMDdi2sW8C8xX0HfLDbqAnpS5clCEfDdRK6sI6bxtvWimjk+z2gexc1hTjexWDgyAacc7U4rsBwRWT9J2bSzmmY4yd9nZZIZIlHYqaf0uRayFR1gcRDUzvmJOf1CNLUQq26f08DUbpBgeKk4dT8wW+nLhLrulkzqe2UivlyCc85JQVTNEuJsMWg/6QbQBy97ja15GcyWttzf9/QjmZEp0GxKfAZQmZCEskFnV+uoNCvG9D5g8kbmq2FLwFsm4EEw0gXmFmr+9FEXFkaLd1MzkGcFfwcOX+YtalARidWrd+SkU2TtDRci6b4qQylvOuFi67SpMQMO5FM6zwZkHqK2hYobq+mpy2ffInYaGJSaWxp+/8BjQ6IJwaiOTtk6R8Q=
branches:
except:
- /^noci-.*$/
4 changes: 2 additions & 2 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Changelog
=========

0.0.1 (YYYY-MM-DD)
0.1.0 (2015-07-25)
------------------

* initial minimal smoke-test release
* initial released version
56 changes: 49 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ awslimitchecker

.. image:: https://pypip.in/v/awslimitchecker/badge.png
:target: https://crate.io/packages/awslimitchecker
:alt: PyPi package version

.. image:: https://pypip.in/d/awslimitchecker/badge.png
:target: https://crate.io/packages/awslimitchecker
:alt: PyPi downloads

.. image:: https://landscape.io/github/jantman/awslimitchecker/master/landscape.svg
:target: https://landscape.io/github/jantman/awslimitchecker/master
Expand All @@ -19,6 +21,30 @@ awslimitchecker
:target: https://codecov.io/github/jantman/awslimitchecker?branch=master
:alt: coverage report for master branch

.. image:: https://readthedocs.org/projects/awslimitchecker/badge/?version=latest
:target: https://readthedocs.org/projects/awslimitchecker/?badge=latest
:alt: sphinx documentation for latest release

.. image:: https://readthedocs.org/projects/awslimitchecker/badge/?version=develop
:target: https://readthedocs.org/projects/awslimitchecker/?badge=develop
:alt: sphinx documentation for develop branch

.. image:: https://img.shields.io/github/release/jantman/awslimitchecker.svg
:alt: GitHub latest release version
:target: https://github.com/jantman/awslimitchecker/releases

.. image:: https://img.shields.io/github/forks/jantman/awslimitchecker.svg
:alt: GitHub Forks
:target: https://github.com/jantman/awslimitchecker/network

.. image:: https://img.shields.io/github/stars/jantman/awslimitchecker.svg
:alt: GitHub Stars
:target: https://github.com/jantman/awslimitchecker

.. image:: https://img.shields.io/github/issues/jantman/awslimitchecker.svg
:alt: GitHub Open Issues
:target: https://github.com/jantman/awslimitchecker/issues

.. image:: http://www.repostatus.org/badges/0.1.0/active.svg
:alt: Project Status: Active - The project has reached a stable, usable state and is being actively developed.
:target: http://www.repostatus.org/#active
Expand All @@ -35,18 +61,30 @@ Advisor where available), notifying you when you are approaching or at your limi
Full project documentation is available at `http://awslimitchecker.readthedocs.org <http://awslimitchecker.readthedocs.org>`_.

Status
-------
------

This project is currently in very early development. At this time please consider it alpha code and not reliable;
furthermore its API may be changing rapidly. I hope to have this stabilized soon. I wouldn't call it ready for
use, but contributions are certainly welcome.

What It Does
------------

- Check current AWS resource usage against AWS Service Limits
- Show and inspect current usage
- Override default Service Limits (for accounts with increased limits)
- Compare current usage to limits; return information about limits that
exceed thresholds, and (CLI wrapper) exit non-0 if thresholds are exceeded
- Define custom thresholds per-limit
- where possible, pull current limits from Trusted Advisor API

Requirements
------------

* Python 2.6 or 2.7 (`boto <http://docs.pythonboto.org/en/latest/>`_ currently has incomplete python3 support)
* Python 2.6 through 3.4. Python 2.x is recommended, as `boto <http://docs.pythonboto.org/en/latest/>`_ (the AWS client library) currently has
incomplete Python3 support. See the `boto documentation <http://boto.readthedocs.org/en/latest/>`_ for a list of AWS services that are Python3-compatible.
* Python `VirtualEnv <http://www.virtualenv.org/>`_ and ``pip`` (recommended installation method; your OS/distribution should have packages for these)
* `boto <http://docs.pythonboto.org/en/latest/>`_ >= 2.30.0
* `boto <http://docs.pythonboto.org/en/latest/>`_ >= 2.32.0

Installation
------------
Expand All @@ -61,11 +99,14 @@ system-wide, you can (using sudo).
pip install awslimitchecker
Credentials
------------
-----------

awslimitchecker does nothing with AWS credentials, it leaves that to boto itself.
You must either have your credentials configured in one of boto's supported config
files, or set as environment variables. See `boto config <http://docs.pythonboto.org/en/latest/boto_config_tut.html>`_
files, or set as environment variables. See
`boto config <http://docs.pythonboto.org/en/latest/boto_config_tut.html>`_
and
`this project's documentation <http://awslimitchecker.readthedocs.org/en/latest/getting_started.html#credentials>`_
for further information.

Usage
Expand All @@ -77,7 +118,8 @@ For basic usage, see:
awslimitchecker --help
See the `project documentation <http://awslimitchecker.readthedocs.org>`_ for further information.
See the `project documentation <http://awslimitchecker.readthedocs.org>`_
for further information.

Bugs and Feature Requests
-------------------------
Expand All @@ -89,7 +131,7 @@ Pull requests are always welcome.
Please see the [Development]() and [Getting Help]() documentation for more information.

License
--------
-------

awslimitchecker is licensed under the `GNU Affero General Public License, version 3 or later <http://www.gnu.org/licenses/agpl.html>`_.
This shouldn't be much of a concern to most people.
Expand Down
2 changes: 1 addition & 1 deletion awslimitchecker/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
################################################################################
While not legally required, I sincerely request that anyone who finds
bugs please submit them at <https://github.com/jantman/pydnstest> or
bugs please submit them at <https://github.com/jantman/awslimitchecker> or
to me via email, and that you send any contributions or improvements
either as a pull request on GitHub, or to me via email.
Expand Down
Loading

0 comments on commit c5b0225

Please sign in to comment.