Skip to content

lightnarcissus/FilingAlert

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Filing Scraper

Builds and deploys an AWS-hosted helper service which sends email updates if there are any relevant filings made by law firms. Can be generalized for other scraping operations as well. The CDK project builds up following AWS resources:

  • Lambda
  • S3 Bucket
  • SNS Email Topic
  • EventBridge CRON Trigger to Lambda (Daily)

The Python Hatch project underpins the Lambda service performing the scraping and S3 file orchestration and updates via SNS if there have been any updates.

Installation

Prerequisites

  • Python >=3.7 and Pip
  • Node (v20.9.0)
  • CDK v2.1

AWS Deployment via CDK

Builds up following AWS resources:

  • Lambda
  • S3 Bucket
  • SNS Email Topic
  • EventBridge CRON Trigger to Lambda (Daily)

Ensure you're inside filing-alert-app directory

cd filing-alert-app

The cdk.json file tells the CDK Toolkit how to execute your app.

Requires you to specify environmentName as a context variable in CDK to define your stack's resources.

cdk synth -c environmentName=<YOUR ENV NAME>
cdk deploy -c environmentName=<YOUR ENV NAME> -c email=<EMAIL ADDRESS TO BE NOTIFIED>

Python Hatch Project

Ensure you're inside filing-scraper-lambda directory

cd filing-scraper-lambda

Then install Hatch and activate the shell

pip install hatch
hatch shell

Set environment variable S3_BUCKET_NAME to your S3 bucket.

python ./filing_scraper/scraper.py

More instructions under project README

License

filing-scraper is distributed under the terms of the MIT license.

About

Builds and deploys an AWS service which sends email updates if there are any relevant filings made by law firms. Can be extended for other generalized scraping operations

Topics

Resources

License

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors