# AWS Allowlist
[](https://github.com/geoffreywiseman/awswl/actions/workflows/ci.yml)
[](https://pepy.tech/project/awswl)
[](https://awswl.readthedocs.io/en/latest/)
A small tool to make it pretty simple to add and remove ip addresses (or CIDR blocks) from an AWS security group. This acts like a sort of oversimplified VPN, where you can quickly give yourself SSH access to a project as you move about from network to network.
This README should have enough information to get started, but you can get more information on:
- recent changes in the [CHANGELOG](CHANGELOG.md)
- documentation on [Read The Docs](https://awswl.readthedocs.io/en/latest/)
- [Alternatives](docs/alternatives.md) to awswl
## Installing 🛠️
This is a python tool, packaged as a python module, so you should be able to just run
```bash
pip install awswl
```
Of course, if you don't know what a python module is, or you don't have python and pip installed,
you may have additional work ahead of you.
Now that Python2 is largely a relic of the past, I'm focused on supporting Python 3 only. The current CI build is for Python 3.9+.
## Usage ⌨
If you want usage help at the command line, try:
```bash
awswl --help
```
There's more detailed usage documentation in the documentation, which you can read on [GitHub](docs/usage.md) or [readthedocs](https://awswl.readthedocs.io/en/latest/usage/).
## Environment
All of these require you to have AWS credentials set up in advance, stored in
``~/.aws/credentials``, and if you need to use a profile, you can configure it with
``AWS_PROFILE``. If you want to identify the security group using a command-line variable so that
you don't have to put it into each command invocation, you can put it in ``AWSWL_SGID``.
Raw data
{
"_id": null,
"home_page": "https://github.com/geoffreywiseman/awswl",
"name": "awswl",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "aws,vpn,securitygroups,security,networking,allowlist,ssh,firewall,utility",
"author": "Geoffrey Wiseman",
"author_email": "geoffrey.wiseman@codiform.com",
"download_url": "https://files.pythonhosted.org/packages/ef/ce/b867f9b437baa464ee09c91c422200f89a5856544e078a7b114967db4c01/awswl-1.1.0.tar.gz",
"platform": null,
"description": "# AWS Allowlist\n\n[](https://github.com/geoffreywiseman/awswl/actions/workflows/ci.yml)\n[](https://pepy.tech/project/awswl)\n[](https://awswl.readthedocs.io/en/latest/)\n\nA small tool to make it pretty simple to add and remove ip addresses (or CIDR blocks) from an AWS security group. This acts like a sort of oversimplified VPN, where you can quickly give yourself SSH access to a project as you move about from network to network.\n\nThis README should have enough information to get started, but you can get more information on:\n- recent changes in the [CHANGELOG](CHANGELOG.md)\n- documentation on [Read The Docs](https://awswl.readthedocs.io/en/latest/)\n- [Alternatives](docs/alternatives.md) to awswl\n\n## Installing \ud83d\udee0\ufe0f\n\nThis is a python tool, packaged as a python module, so you should be able to just run\n\n```bash\npip install awswl\n``` \n\nOf course, if you don't know what a python module is, or you don't have python and pip installed,\nyou may have additional work ahead of you.\n\nNow that Python2 is largely a relic of the past, I'm focused on supporting Python 3 only. The current CI build is for Python 3.9+.\n\n## Usage \u2328\n\nIf you want usage help at the command line, try:\n\n```bash\nawswl --help\n```\n\nThere's more detailed usage documentation in the documentation, which you can read on [GitHub](docs/usage.md) or [readthedocs](https://awswl.readthedocs.io/en/latest/usage/).\n\n\n## Environment\n\nAll of these require you to have AWS credentials set up in advance, stored in\n``~/.aws/credentials``, and if you need to use a profile, you can configure it with\n``AWS_PROFILE``. If you want to identify the security group using a command-line variable so that\nyou don't have to put it into each command invocation, you can put it in ``AWSWL_SGID``.\n",
"bugtrack_url": null,
"license": "Public Domain",
"summary": "A project to make it simple to add/remove ip addresses (or CIDR blocks) from an AWS Security group.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/geoffreywiseman/awswl",
"Repository": "https://github.com/geoffreywiseman/awswl"
},
"split_keywords": [
"aws",
"vpn",
"securitygroups",
"security",
"networking",
"allowlist",
"ssh",
"firewall",
"utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e3f34eb8718c84ba3a39a602cf363d342289bcef654fd031aeb0c2449e264c6",
"md5": "6b0ea3110da8007aac3cb446080adda1",
"sha256": "21ccbb7e9fbf7641b91acf9025a34bcee06ba6f066ad12c207f23f3e7a0a12af"
},
"downloads": -1,
"filename": "awswl-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b0ea3110da8007aac3cb446080adda1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 7168,
"upload_time": "2023-09-19T13:47:00",
"upload_time_iso_8601": "2023-09-19T13:47:00.964340Z",
"url": "https://files.pythonhosted.org/packages/3e/3f/34eb8718c84ba3a39a602cf363d342289bcef654fd031aeb0c2449e264c6/awswl-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "efceb867f9b437baa464ee09c91c422200f89a5856544e078a7b114967db4c01",
"md5": "d5f4e99c9f277e1c868ff493aa15857c",
"sha256": "8d17395c56264a73d9d9b1ccf33009e90f5d68ed5b90ff5f8360d8ac9dcaf943"
},
"downloads": -1,
"filename": "awswl-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d5f4e99c9f277e1c868ff493aa15857c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 5749,
"upload_time": "2023-09-19T13:47:03",
"upload_time_iso_8601": "2023-09-19T13:47:03.275236Z",
"url": "https://files.pythonhosted.org/packages/ef/ce/b867f9b437baa464ee09c91c422200f89a5856544e078a7b114967db4c01/awswl-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-19 13:47:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "geoffreywiseman",
"github_project": "awswl",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "awswl"
}
JSON
