Skip to content

Commit

Permalink
Merge pull request #522 from BastianZim/add-conda-download
Browse files Browse the repository at this point in the history
Add conda download
  • Loading branch information
jantman committed Apr 20, 2021
2 parents b6b2e84 + cc6a3c6 commit 9c2d318
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ awslimitchecker
:alt: gitter.im chat
:target: https://gitter.im/awslimitchecker/Lobby

.. image:: https://img.shields.io/conda/v/conda-forge/awslimitchecker
:alt: Conda
:target: https://anaconda.org/conda-forge/awslimitchecker

Master:

.. image:: https://api.travis-ci.com/jantman/awslimitchecker.svg?branch=master
Expand Down Expand Up @@ -104,6 +108,8 @@ Requirements
* Python `VirtualEnv <http://www.virtualenv.org/>`_ and ``pip`` (recommended installation method; your OS/distribution should have packages for these)
* `boto3 <http://boto3.readthedocs.org/>`_ >= 1.4.6 and its dependency `botocore <https://botocore.readthedocs.io/en/latest/>`_ >= 1.6.0.

Alternatively, awslimitchecker may be installed through `conda <https://docs.conda.io/en/latest/>`_ with ``conda install -c conda-forge awslimitchecker``. This will automatically install the required dependencies as well.

Installation and Usage
-----------------------

Expand Down
21 changes: 21 additions & 0 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,27 @@ can be whatever you want):
source limitchecker/bin/activate
pip install awslimitchecker
Alternatively, you may also install awslimitchecker through
`conda <https://docs.conda.io/en/latest/>`_
using the
`conda-forge <https://conda-forge.org>`_
channel.
This can be achieved by adding ``conda-forge`` to your channels with

.. code-block:: bash
conda config --add channels conda-forge
Once activated, ``awslimitchecker`` can then be installed with

.. code-block:: bash
conda install awslimitchecker
We recommend installing awslimitchecker into a separate
`conda environment <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#>`_
.

Version Specification
+++++++++++++++++++++

Expand Down

0 comments on commit 9c2d318

Please sign in to comment.