{"id":13608037,"url":"https://github.com/18F/pulse","last_synced_at":"2025-04-12T14:31:57.097Z","repository":{"id":65432514,"uuid":"31670909","full_name":"18F/pulse","owner":"18F","description":"How the federal .gov domain space is doing at best practices and policies.","archived":true,"fork":false,"pushed_at":"2020-06-09T16:53:40.000Z","size":16624,"stargazers_count":95,"open_issues_count":12,"forks_count":56,"subscribers_count":26,"default_branch":"master","last_synced_at":"2024-11-07T13:39:03.082Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/18F.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-04T17:47:35.000Z","updated_at":"2024-09-24T19:41:51.000Z","dependencies_parsed_at":"2023-01-24T10:31:54.464Z","dependency_job_id":null,"html_url":"https://github.com/18F/pulse","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/18F%2Fpulse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/18F%2Fpulse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/18F%2Fpulse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/18F%2Fpulse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/18F","download_url":"https://codeload.github.com/18F/pulse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248581238,"owners_count":21128130,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T19:01:23.750Z","updated_at":"2025-04-12T14:31:53.610Z","avatar_url":"https://github.com/18F.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"\n\n## This project was decommissioned by the Office of Government-wide Policy and redirected to digitaldashboard.gov in June of 2020.  \n\n\n=================\n\n## The pulse of the federal .gov webspace\n\nHow the .gov domain space is doing at best practices and federal requirements.\n\n| Documentation  |  Other Links |\n|---|---|\n| [Setup and Deploy Instructions](#setup) |  [System Security Plan](https://github.com/18F/pulse/blob/master/system-security-plan.yml) |\n| [a11y scan process](https://github.com/18F/pulse/blob/master/docs/a11y-instructions.md)  | [Ideas for new sections to add to the site](https://github.com/18F/pulse/blob/master/docs/other-sections.md) |\n| [Ongoing Work](https://github.com/18F/pulse/blob/master/docs/project-outline.md) | [Backlog of feature requests and ideas](https://github.com/18F/pulse/issues?utf8=%E2%9C%93\u0026q=is%3Aissue%20label%3Abacklog)  |\n|  [ATO artifacts](https://github.com/18F/pulse/blob/master/docs/ato.md)  | [Open Source Reuse of the site](https://github.com/18F/pulse/blob/master/docs/reuse.md) |\n| [Project Information](https://github.com/18F/pulse/blob/master/.about.yml)  |  |\n\n## Setup\n\nPulse is a [Flask](http://flask.pocoo.org/) app written for **Python 3.5 and up**. We recommend [pyenv](https://github.com/yyuu/pyenv) for easy Python version management.\n\n* Install dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\n* If developing the stylesheets, you will also need [Sass](http://sass-lang.com/), [Bourbon](http://bourbon.io/), [Neat](http://neat.bourbon.io/), and [Bitters](http://bitters.bourbon.io/).\n\n```bash\ngem install sass bourbon neat bitters\n```\n\n* If editing styles during development, keep the Sass auto-compiling with:\n\n```bash\nmake watch\n```\n\n* And to run the app in development, use:\n\n```bash\nmake debug\n```\n\nThis will run the app with `DEBUG` mode on, showing full error messages in-browser when they occur.\n\n### Initializing dataset\n\nTo initialize the dataset with the last production scan data and database, there's a convenience function:\n\n```\nmake data_init\n```\n\nThis will download (using `curl`) the current live production database and scan data to the local `data/` directory.\n\n\n### Install domain-scan and dependencies\n\nDownload and set up `domain-scan` [from GitHub](https://github.com/18F/domain-scan).\n\n`domain-scan` in turn requires [`pshtt`](https://github.com/dhs-ncats/pshtt) and [`sslyze`](https://github.com/nabla-c0d3/sslyze). These can be installed directly via `pip`.\n\nPulse requires you to set one environment variable:\n\n* `DOMAIN_SCAN_PATH`: A path to `domain-scan`'s `scan` binary.\n\nHowever, if you don't have `pshtt` and `sslyze` on your PATH, then `domain-scan` may need you to set a couple others:\n\n* `PSHTT_PATH`: Path to the `pshtt` binary.\n* `SSLYZE_PATH`: Path to the `sslyze` binary.\n\n### Configure the AWS CLI\n\nTo publish the resulting data to the production S3 bucket, install the official AWS CLI:\n\n```\npip install awscli\n```\n\nAnd link it to AWS credentials that allow authorized write access to the `pulse.cio.gov` S3 bucket.\n\n### Then run it\n\nFrom the Pulse root directory:\n\n```\npython -m data.update\n```\n\nThis 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.\n\nThen it will run the scan data through post-processing to produce some JSON and CSV files the Pulse front-end uses to render data.\n\nFinally, this data will be uploaded to the production S3 bucket.\n\n\n### Public domain\n\nThis project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):\n\n\u003e 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](https://creativecommons.org/publicdomain/zero/1.0/).\n\u003e\n\u003e 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F18F%2Fpulse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F18F%2Fpulse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F18F%2Fpulse/lists"}