{
    "info": {
        "author": "Cyber and Infrastructure Security Agency",
        "author_email": "ncats@hq.dhs.gov",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6"
        ],
        "description": "# dmarc-import :postal_horn: :mailbox: #\n\n[![Build Status](https://travis-ci.org/cisagov/dmarc-import.svg?branch=develop)](https://travis-ci.org/cisagov/dmarc-import)\n[![Coverage Status](https://coveralls.io/repos/github/cisagov/dmarc-import/badge.svg?branch=develop)](https://coveralls.io/github/cisagov/dmarc-import?branch=develop)\n\n`dmarc-import` is a tool for parsing DMARC aggregate reports.  The\nexpected format of these aggregate reports is described in\n[RFC 7489](https://tools.ietf.org/html/rfc7489#section-7.2.1.1).\n\n## Installation of the Python package ##\n\n### From PyPI ###\n\n```bash\npip install dmarc-import\n```\n\n### From your local checkout ###\nAfter using `git` to clone the repository, you can install\n`dmarc-import` using `pip`:\n```bash\npip install /path/to/dmarc-import\n```\n\n### From GitHub ###\nOr, if you prefer, you can install directly from\n[the GitHub repository](https://github.com/cisagov/dmarc-import):\n```bash\npip install git+https://github.com/cisagov/dmarc-import.git\n```\n\n## Building the Docker image ##\n\nAs an alternative to installing the Python package, you can instead\nchoose to build the Docker image:\n```bash\ndocker-compose build\n```\n\n## Usage ##\n\n```bash\nUsage:\n  dmarc-import --schema=SCHEMA --s3-bucket=BUCKET [--s3-keys=KEYS] [--domains=FILE] [--reports=DIRECTORY] [--elasticsearch=URL] [--es-region=REGION] [--log-level=LEVEL] [--dmarcian-token=FILE] [--delete]\n  dmarc-import (-h | --help)\n\nOptions:\n  -h --help               Show this message.\n  --log-level=LEVEL       If specified, then the log level will be set to the\n                          specified value.  Valid values are \"debug\", \"info\",\n                          \"warn\", and \"error\".\n  --schema=SCHEMA         The XSD file against which the DMARC aggregate\n                          reports are to be be verified.\n  --s3-bucket=BUCKET      The AWS S3 bucket containing the DMARC aggregate\n                          reports.\n  --s3-keys=KEYS          A comma-separated list of DMARC aggregate report\n                          keys.  If specified, only the specified DMARC\n                          aggregate reports will be processed.  Otherwise all\n                          reports in the AWS S3 bucket will be processed.\n  --domains=FILE          A file to which to save a list of all domains for\n                          which DMARC aggregate reports were received.  If not\n                          specified then no such file will be created.\n  --reports=DIRECTORY     A directory to which to write files containing DMARC\n                          aggregate report contents.  If not specified then no\n                          such files will be created.\n  --elasticsearch=URL     A URL corresponding to an AWS Elasticsearch\n                          instance, including the index where the DMARC\n                          aggregate reports should be written.\n  --es-region=REGION      The AWS region where the Elasticsearch instance\n                          is located.\n  --dmarcian-token=FILE   A simple text file whose only contents are the\n                          Dmarcian API token.  If specified then the\n                          Dmarcian API will be queried to determine what\n                          commercial mail-sending organization (if any) is\n                          associated with the IP in the aggregate report.\n  --delete                If present then the reports will be deleted after\n                          processing.\n```\n\n## Setting up Docker secrets ##\n\nBefore attempting to run this project via `docker-compose`, you must\ncreate a `secrets` directory and a few files inside it that contain\ncredentials for the Docker container to use.  These files are:\n* `secrets/aws/config` - [an ini format file containing the AWS\n  configuration](http://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html)\n* `secrets/aws/credentials` - [an ini format file containing the AWS\n  credentials](http://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html)\n* `secrets/dmarcian/token` - a text file containing a [Dmarcian API\n  token](https://dmarcian.com/)\n\n## License ##\n\nThis project is in the worldwide [public domain](LICENSE.md).\n\nThis project is in the public domain within the United States, and\ncopyright and related rights in the work worldwide are waived through\nthe [CC0 1.0 Universal public domain\ndedication](https://creativecommons.org/publicdomain/zero/1.0/).\n\nAll contributions to this project will be released under the CC0\ndedication. By submitting a pull request, you are agreeing to comply\nwith this waiver of copyright interest.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "https://github.com/cisagov/dmarc-import",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://www.us-cert.gov/resources/ncats",
        "keywords": "dmarc,rua",
        "license": "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
        "maintainer": "",
        "maintainer_email": "",
        "name": "dmarc-import",
        "package_url": "https://pypi.org/project/dmarc-import/",
        "platform": "",
        "project_url": "https://pypi.org/project/dmarc-import/",
        "project_urls": {
            "Download": "https://github.com/cisagov/dmarc-import",
            "Homepage": "https://www.us-cert.gov/resources/ncats"
        },
        "release_url": "https://pypi.org/project/dmarc-import/1.1.1/",
        "requires_dist": [
            "boto3 (>=1.4.7)",
            "docopt (>=0.6.2)",
            "lxml (==4.1.1)",
            "requests (>=2.18.4)",
            "requests-aws4auth (>=0.9)",
            "xmljson (>=0.1.9)",
            "check-manifest (>=0.36) ; extra == 'dev'",
            "pytest (>=3.5.0) ; extra == 'dev'",
            "semver (>=2.7.9) ; extra == 'dev'",
            "tox (>=3.0.0) ; extra == 'dev'",
            "wheel (>=0.31.0) ; extra == 'dev'"
        ],
        "requires_python": "",
        "summary": "A tool for parsing DMARC aggregate reports",
        "version": "1.1.1"
    },
    "last_serial": 4876249,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e8c8e82789fdf91a775e35973952d2cc",
                    "sha256": "ae6a52c35f75d6f1205fb00631c35bc8b49b84579cc37335decefbb6c89f9192"
                },
                "downloads": -1,
                "filename": "dmarc_import-1.0.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e8c8e82789fdf91a775e35973952d2cc",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 14826,
                "upload_time": "2018-05-20T18:12:18",
                "url": "https://files.pythonhosted.org/packages/e5/b3/49c5399f75bab7422969b4ce066b2ce17a8be59701e7c1486a723f407565/dmarc_import-1.0.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "3ec2e912df3e7c3eb78dc7d04e3e970e",
                    "sha256": "e5adb03e891bfd6f2f6eb101238c32b8f23e7b87f7806ff2b382186fa5033eb3"
                },
                "downloads": -1,
                "filename": "dmarc-import-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "3ec2e912df3e7c3eb78dc7d04e3e970e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 15236,
                "upload_time": "2018-05-20T18:12:19",
                "url": "https://files.pythonhosted.org/packages/2a/f7/7be3b101f9c0ef9529edc46ba277597af77e5d8f159352617a9f4895dd19/dmarc-import-1.0.0.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3ee889e0496c683a23f771c13febfffc",
                    "sha256": "f1ff9744ff73018b91e22e22ffc19eeca292a61dccd3ab6365694990194e8ec6"
                },
                "downloads": -1,
                "filename": "dmarc_import-1.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3ee889e0496c683a23f771c13febfffc",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 16449,
                "upload_time": "2018-12-13T15:29:30",
                "url": "https://files.pythonhosted.org/packages/91/c0/3a484d8e7df75750b7737156f50846bbc74c1b93faa0f23d03f9547b573f/dmarc_import-1.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a070923d4d5cfe0a5999f4140402945b",
                    "sha256": "42d922ba78e6d0ba2050599390f80e7eed15453e1b601480676f5e60d184b9b2"
                },
                "downloads": -1,
                "filename": "dmarc-import-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a070923d4d5cfe0a5999f4140402945b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16203,
                "upload_time": "2018-12-13T15:29:32",
                "url": "https://files.pythonhosted.org/packages/b4/2c/0bb5816e33653cebee19990410b571a157339019ebc00b8cf1d0d33b0bbe/dmarc-import-1.1.0.tar.gz"
            }
        ],
        "1.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b8722ad7e3db03e70eeaa01644260386",
                    "sha256": "bd688764b913ec4d1c05bbbd2c9124e2a1272eea9a8d6634c5b706453cbab5b9"
                },
                "downloads": -1,
                "filename": "dmarc_import-1.1.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b8722ad7e3db03e70eeaa01644260386",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 18279,
                "upload_time": "2019-02-27T21:49:11",
                "url": "https://files.pythonhosted.org/packages/00/f0/36950f3d21e9a47bf895db0abb13c53619eedbff0d125746d150fb17f477/dmarc_import-1.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "cddcbe9b24aa1cf3c9ef02bfb404897c",
                    "sha256": "a7c585a89145496a58a8d26445df73cd206a465e0f0cbc8e4234b8fcafc89f93"
                },
                "downloads": -1,
                "filename": "dmarc-import-1.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "cddcbe9b24aa1cf3c9ef02bfb404897c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 15594,
                "upload_time": "2019-02-27T21:49:12",
                "url": "https://files.pythonhosted.org/packages/d6/6e/5c02685720060ec5e9801e64d475abfe66b097fd42d9a9f6c57b0da10428/dmarc-import-1.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b8722ad7e3db03e70eeaa01644260386",
                "sha256": "bd688764b913ec4d1c05bbbd2c9124e2a1272eea9a8d6634c5b706453cbab5b9"
            },
            "downloads": -1,
            "filename": "dmarc_import-1.1.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b8722ad7e3db03e70eeaa01644260386",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 18279,
            "upload_time": "2019-02-27T21:49:11",
            "url": "https://files.pythonhosted.org/packages/00/f0/36950f3d21e9a47bf895db0abb13c53619eedbff0d125746d150fb17f477/dmarc_import-1.1.1-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "cddcbe9b24aa1cf3c9ef02bfb404897c",
                "sha256": "a7c585a89145496a58a8d26445df73cd206a465e0f0cbc8e4234b8fcafc89f93"
            },
            "downloads": -1,
            "filename": "dmarc-import-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "cddcbe9b24aa1cf3c9ef02bfb404897c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15594,
            "upload_time": "2019-02-27T21:49:12",
            "url": "https://files.pythonhosted.org/packages/d6/6e/5c02685720060ec5e9801e64d475abfe66b097fd42d9a9f6c57b0da10428/dmarc-import-1.1.1.tar.gz"
        }
    ]
}