Note Now cloudgeass has an official documentation page on readthedocs! possui uma documentação oficial no readthedocs! Check it out to get access to the latest features!
Quickstart
To start using the package, just install it using pip (or any other Python dependency management of your choose) as:
pip install cloudgeass
You may want to install cloudgeass in a Python virtual environment to get a good control of your project or application dependencies. If you don't know what this is about, feel free to take a look at this excellent article from Real Python.
Modules
Getting straight to the point, each cloudgeass module represents an AWS service that contains at least one class and a bunch of methods built from both boto's source client and resource for that service.
In other words, some modules that you can find here are:
cloudgeass.aws.s3for working with S3 servicecloudgeass.aws.ec2for working with EC2 servicecloudgeass.aws.secretsfor working with Secrets Manager service- and some others
Classes
Each one of the aforementioned modules have at least one class that can be imported on user's application in order to provide access to all features for that given AWS service. So, we have:
cloudgeass.aws.s3.S3Clientclass with methods to operate with S3 servicecloudgeass.aws.ec2.EC2Clientclass with methods to operate with EC2 servicecloudgeass.aws.secrets.SecretsManagerClientclass with methods to operate with Secrets Manager service- and some others
Attributes
All cloudgeass' service classes are initialized with a set of predefined attributes to make the work easier. Those basic attributes are:
| Service class attribute | Description |
|---|---|
self.logger |
A preconfigured logger object to build and stream informative log messages |
self.client |
A boto3 client for the given service |
self.resource |
A boto3 resource for the given service |
The attributes can be externally accessed for all class instances created on an application. This means users can build an application using both cloudgeass and source boto3 code.
Methods
Finally, each service class has its own set of methods that, in fact, enables the power of using cloudgeass to do simple tasks in an AWS environment. To mention some of them, we have:
- S3Client.get_last_date_partition() to get the last date partition from a table stored in S3
- EC2Client.get_default_vpc_id() to get the default VPC ID of an AWS account
- SecretsManagerClient.get_secret_string() to get a secret string given a secret ID
Contact me
- GitHub: @ThiagoPanini
- LinkedIn: Thiago Panini
- Hashnode: panini-tech-lab
- DevTo: thiagopanini
References
Python
Docs
- NumPy docstrings
- Eduardo Mendes - Live de Python 189 - MkDocs
- MkDocs
- pmdown-extensions
- GitHub - MkDocs Themes
- GitHub - Material Theme for MkDocs
- Material for MkDocs - Setup
Github
- GitHub Actions - pypa/gh-action-pypi-publish
- Medium - Major, Minor and Patch
- Medium - Automate PyPI Releases with GitHub Actions
Tests
1 maintainer
Metadata
1 maintainer
Release files for cloudgeass 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cloudgeass-2.0.1.tar.gz | 24.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cloudgeass-2.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 51.2 kB
Release files / cloudgeass-2.0.1.tar.gz
| Download URL | cloudgeass-2.0.1.tar.gz |
|---|---|
| Size | 24.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e2693fc0109b9cf50c97f7a5bba98ce3257123f3d5104ff4b1f2ab5987ebcee0
|
|
BLAKE2b-256 checksum How to use checksums |
4f28fbb5cef549bb7bbc7f8a510ad99d397045092e7c440de6fc10c95c118c54
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Release files / cloudgeass-2.0.1-py3-none-any.whl
| Download URL | cloudgeass-2.0.1-py3-none-any.whl |
|---|---|
| Size | 27.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7d30716a8ea452da9eacfe67d5eeb4ed623121cd9c9b1c07dc48050d9953dfa9
|
|
BLAKE2b-256 checksum How to use checksums |
e1848df50dac902b4184edac8f3c8143b3e552c99cccb94bc7be7e1fcb0752f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.5
|
Security for cloudgeass 2.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
