The pulse of the federal .gov webspace
How the .gov domain space is doing at best practices and federal requirements.
- Install dependencies:
pip install -r requirements.txt
gem install sass bourbon neat bitters
- If editing styles during development, keep the Sass auto-compiling with:
- And to run the app in development, use:
This will run the app with
DEBUG mode on, showing full error messages in-browser when they occur.
To initialize the dataset with the last production scan data and database, there's a convenience function:
This will download (using
curl) the current live production database and scan data to the local
Install domain-scan and dependencies
Download and set up
domain-scan from GitHub.
Pulse requires you to set one environment variable:
DOMAIN_SCAN_PATH: A path to
However, if you don't have
sslyze on your PATH, then
domain-scan may need you to set a couple others:
PSHTT_PATH: Path to the
SSLYZE_PATH: Path to the
Configure the AWS CLI
To publish the resulting data to the production S3 bucket, install the official AWS CLI:
pip install awscli
And link it to AWS credentials that allow authorized write access to the
pulse.cio.gov S3 bucket.
Then run it
From the Pulse root directory:
python -m data.update
This will kick off the
domain-scan scanning process for HTTP/HTTPS and DAP participation, using the
.gov domain list as specified in
meta.yml for the base set of domains to scan.
Then it will run the scan data through post-processing to produce some JSON and CSV files the Pulse front-end uses to render data.
Finally, this data will be uploaded to the production S3 bucket.
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.