Skip to content
This repository has been archived by the owner on Dec 17, 2021. It is now read-only.

WIP: Creating a Python package #231

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[bdist_wheel]
universal = true
84 changes: 84 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
"""
setup module for domain-scan

Based on:

- https://packaging.python.org/distributing/
- https://github.com/pypa/sampleproject/blob/master/setup.py
- https://github.com/dhs-ncats/pshtt/blob/master/setup.py
"""

from setuptools import setup

setup(
name='domain-scan',

# Versions should comply with PEP440
version='0.1.0-dev',
description='lightweight scan pipeline for orchestrating third party tools, at scale and (optionally) using serverless infrastructure',

# NCATS "homepage"
url='https://18f.gsa.gov',
# The project's main homepage
download_url='https://github.com/18F/domain-scan',

# Author details
author='GSA 18F',
# TODO: What is the right email -- author_email='[email protected]',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@konklone -- do you know the right email for here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't! But maybe we can just start with [email protected] for now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, that was one thought I'd had.


license='License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication',

# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers=[
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 4 - Beta',

# Indicate who your project is intended for
'Intended Audience :: Developers',

# Pick your license as you wish (should match "license" above)
'License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication',

# Specify the Python versions you support here. In particular, ensure
# that you indicate whether you support Python 2, Python 3 or both.
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
],

# What does your project relate to?
keywords='https best practices',

packages=['pshtt'],

install_requires=[
'strict-rfc3339',
'publicsuffix',
'boto3',
'ipython',
'sslyze>=1.3.4,<1.4.0',
'cryptography',
'pyyaml',
'requests',
'google-cloud-bigquery',
'google-auth-oauthlib'
],

extras_require={
'test': [
'pytest'
],
},

# Conveniently allows one to run the CLI scripts
scripts=[
'gather',
'scan',
]
)