Skip to content

Commit

Permalink
Shift common EFI logic into file_ingestion
Browse files Browse the repository at this point in the history
  • Loading branch information
tim.reichard committed Oct 8, 2021
1 parent 21bc9bd commit af68cf0
Show file tree
Hide file tree
Showing 12 changed files with 988 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/.pre-commit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ jobs:
run: |
pip install -r aioradio/requirements.txt
pylint aioradio/*.py aioradio/tests/*.py --disable=similarities
pytest -vss --github=true --cov=aioradio --cov-config=.coveragerc --cov-report html --cov-fail-under=70
pytest -vss --github=true --cov=aioradio --cov-config=.coveragerc --cov-report html --cov-fail-under=60
7 changes: 6 additions & 1 deletion HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@ History
=======


v0.15.0 (2021-10-06)

* Shift common EFI logic into file_ingestion to be used by EFI and Datalab File Upload systems.


v0.14.5 (2021-10-06)

* Updating python modules and loosening versioning of sub-dependencies
* Updating python modules and loosening versioning of sub-dependencies.


v0.14.4 (2021-09-27)
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ lint:
test:
. env/bin/activate; \
export AWS_PROFILE=sandbox; \
pytest -vss --cov=aioradio --cov-config=.coveragerc --cov-report=html --cov-fail-under=75
pytest -vss --cov=aioradio --cov-config=.coveragerc --cov-report=html --cov-fail-under=60

pre-commit:
. env/bin/activate; \
Expand Down
162 changes: 162 additions & 0 deletions aioradio.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
Metadata-Version: 2.1
Name: aioradio
Version: 0.15.0
Summary: Generic asynchronous i/o python utilities for AWS services (SQS, S3, DynamoDB, Secrets Manager), Redis, MSSQL (pyodbc), JIRA and more
Home-page: https://github.com/nrccua/aioradio
Author: NRCCUA Architects
License: MIT
Description: # aioradio
Generic asynchronous i/o python utilities for AWS services (SQS, S3, DynamoDB, Secrets Manager), Redis, MSSQL (pyodbc), JIRA and more.

## AWS S3 example code
aioradio abstracts using aiobotocore and aioboto3 making async AWS funtion calls simple one liners.
Besides what is shown below in the examples, there is also support for SQS, DynamoDB and Secrets Manager.


```python
import asyncio

from aioradio.aws.s3 import create_bucket
from aioradio.aws.s3 import delete_s3_object
from aioradio.aws.s3 import download_file
from aioradio.aws.s3 import get_object
from aioradio.aws.s3 import list_s3_objects
from aioradio.aws.s3 import upload_file

async def main():
s3_bucket = 'aioradio'
s3_prefix = 'test'
filename = 'hello_world.txt'
s3_key = f'{s3_prefix}/{filename}'

# create an s3 bucket called aioradio
await create_bucket(bucket=s3_bucket)

# create hello_world.txt file
with open(filename, 'w') as file_handle:
file_handle.write('hello world of aioradio!')

# upload the file from s3 and confirm it now exists in s3
await upload_file(bucket=s3_bucket, filepath=filename, s3_key=s3_key)
assert s3_key in await list_s3_objects(bucket=s3_bucket, s3_prefix=s3_prefix)

# test downloading the file
await download_file(bucket=s3_bucket, filepath=filename, s3_key=s3_key)

# test getting file data to object
result = await get_object(bucket=s3_bucket, s3_key=s3_key)
assert result == b'hello world of aioradio!'

# delete the file from s3
await delete_s3_object(bucket=s3_bucket, s3_prefix=s3_key)
assert s3_key not in await list_s3_objects(bucket=s3_bucket, s3_prefix=s3_prefix)

asyncio.get_event_loop().run_until_complete(main())
```

## MSSQL example code
aioredis uses the pyodbc library to work with ODBC databases.
It currently has support for connecting and sending queries to mssql.

```python
import asyncio

from aioradio.pyodbc import establish_pyodbc_connection
from aioradio.pyodbc import pyodbc_query_fetchone
from aioradio.pyodbc import pyodbc_query_fetchall

async def main():
conn = await establish_pyodbc_connection(host='your-host', user='your-user', pwd='your-password')

query = "SELECT homeruns FROM MLB.dbo.LosAngelesAngels WHERE lastname = 'Trout' AND year = '2020'"
row = await pyodbc_query_fetchone(conn=conn, query=query)
print(row)

query = "SELECT homeruns FROM MLB.dbo.LosAngelesAngels WHERE lastname = 'Trout'"
rows = await pyodbc_query_fetchall(conn=conn, query=query)
print(rows)


asyncio.get_event_loop().run_until_complete(main())
```

## Jira example code
Jira uses the async library httpx behind the scene to send http requests.

```python
import asyncio

from aioradio.jira import add_comment_to_jira
from aioradio.jira import get_jira_issue
from aioradio.jira import post_jira_issue

async def main():

# create a jira ticket
url = 'https://aioradio.atlassian.net/rest/api/2/issue/'
payload = {
"fields": {
"project": {"key": "aioradio"},
"issuetype": {"name": "Task"},
"reporter": {"accountId": "somebodies-account-id"},
"priority": {"name": "Medium"},
"summary": "Aioradio rocks!",
"description": "Aioradio Review",
"labels": ["aioradio"],
"assignee": {"accountId": "somebodies-account-id"}
}
}
resp = await post_jira_issue(url=url, jira_user='your-user', jira_token='your-password', payload=payload)
jira_id = resp.json()['key']

# get jira ticket info
resp = await get_jira_issue(url=f'{url}/{jira_id}', jira_user='your-user', jira_token='your-password')

# add comment to jira ticket
comment = 'aioradio rocks!'
response = await add_comment_to_jira(url=url, jira_user='your-user', jira_token='your-password', comment=comment)

asyncio.get_event_loop().run_until_complete(main())
```

## INSTALLING FOR DIRECT DEVELOPMENT OF AIORADIO

Install [python 3.9.X](https://www.python.org/downloads/)

Make sure you've installed [ODBC drivers](https://docs.microsoft.com/en-us/sql/connect/python/pyodbc/step-1-configure-development-environment-for-pyodbc-python-development?view=sql-server-ver15), required for using the python package pyodbc.

Clone aioradio locally and navigate to the root directory

Install and activate python VirtualEnv
```bash
python3.9 -m venv env
source env/bin/activate
```

Install python modules included in requirements.txt
```bash
pip install -r aioradio/requirements.txt
```

Run Makefile command from the root directory to test all is good before issuing push to master
```
make all
```

## AUTHORS

* **Tim Reichard** - [aioradio](https://github.com/nrccua/aioradio)

See also the list of [contributors](https://github.com/nrccua/aioradio/graphs/contributors) who participated in this project.

## ACKNOWLEDGEMENTS

* **Bryan Cusatis** - Architect contributing to aioradio.
* **Kyle Edwards** - Developer contributing to aioradio.
* **Pedro Artiga** - Developer contributing to aioradio.

Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
26 changes: 26 additions & 0 deletions aioradio.egg-info/SOURCES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
LICENSE
MANIFEST.in
README.md
setup.cfg
setup.py
aioradio/__init__.py
aioradio/file_ingestion.py
aioradio/jira.py
aioradio/logger.py
aioradio/long_running_jobs.py
aioradio/psycopg2.py
aioradio/pyodbc.py
aioradio/redis.py
aioradio/utils.py
aioradio.egg-info/PKG-INFO
aioradio.egg-info/SOURCES.txt
aioradio.egg-info/dependency_links.txt
aioradio.egg-info/not-zip-safe
aioradio.egg-info/requires.txt
aioradio.egg-info/top_level.txt
aioradio/aws/dynamodb.py
aioradio/aws/moto_server.py
aioradio/aws/s3.py
aioradio/aws/secrets.py
aioradio/aws/sqs.py
aioradio/aws/utils.py
1 change: 1 addition & 0 deletions aioradio.egg-info/dependency_links.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions aioradio.egg-info/not-zip-safe
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

14 changes: 14 additions & 0 deletions aioradio.egg-info/requires.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
aioboto3>=9.2.1
aiobotocore>=1.4.2
aiojobs>=0.3.0
boto3==1.17.106
ddtrace>=0.53.3
fakeredis>=1.6.1
httpx>=0.19.0
mandrill>=1.0.60
numpy>=1.21.2orjson>=3.6.4
psycopg2-binary==2.9.1
pysmb>=1.2.7
python-json-logger>=2.0.2
redis>=3.5.3
xlrd==2.0.1
2 changes: 2 additions & 0 deletions aioradio.egg-info/top_level.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
aioradio
aioradio/aws
Loading

0 comments on commit af68cf0

Please sign in to comment.