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

Conversation

IanLee1521
Copy link
Member

@IanLee1521 IanLee1521 commented Mar 29, 2018

TODO:

  • Need to shuffle around several of the directories to make this work for real.

setup.py Outdated

# 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.

@IanLee1521
Copy link
Member Author

This actually appears to be working now as is, but I'm going to use this as an excuse to roll this into a proper package structure while I'm touching it.

@IanLee1521
Copy link
Member Author

FYI -- There is now an (early, WIP) version of the package uploaded at: https://pypi.org/project/domain-scan/

You should be able to now: pip install --pre domain-scan to test that piece of the puzzle. That said, I will need to make version 2 for the actual scripts to work, currently they fail with:

> scan --help
Traceback (most recent call last):
  File "/Users/lee1001/.virtualenvs/python3/bin/scan", line 19, in <module>
    from scanners.headless.local_bridge import headless_scan
ModuleNotFoundError: No module named 'scanners'

@konklone
Copy link
Contributor

konklone commented Apr 1, 2018

@IanLee1521 This is great progress. Thank you for working on this!

Also, @jsf9k and I just maybe-simplified or maybe-complicated this work, by splitting out the requirements into different places in #224.

In a pip install-able use case, should it install the scanner and gatherer-specific reqs by default? This would have been the default previously, so keeping it that way by installing from all 3 .txt files would at least be the status quo.

I don't think we yet have a live downstream use case of the pip install workflow for domain-scan, so I guess I'd look to @jsf9k or @JasonMWhite (or others) for suggestions on what the right interface is here.

@jsf9k
Copy link
Collaborator

jsf9k commented Apr 2, 2018

I think we could keep the requirements split up by adding gatherers, scanners, etc. sections to extras_require in setup.py.

This is what I've done with the testing requirements in pshtt, for example. pip install . will install the install_requires, and if you want to install those requirements and the ones for testing then you just do pip install .[test].

I also modified requirements.txt in pshtt to automatically parrot what is already in setup.py. I think it would be good if we can do the same with our various requirements files here, since then we only need to maintain the setup.py file.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants