Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme Changes #3

Closed
adamwjo opened this issue Aug 20, 2020 · 2 comments
Closed

Readme Changes #3

adamwjo opened this issue Aug 20, 2020 · 2 comments
Assignees

Comments

@adamwjo
Copy link
Contributor

adamwjo commented Aug 20, 2020

#2

Did you still want to include the info on the scraper? Or perhaps a caveat about it actually taking a long time to run?

Also noting the $ python3 <filename> command with macs. Python novice here, so wasn't immediately apparent the difference between the commands "python" and "python3".

I think some language describing in better detail where the congress data should exist in the repo before you run the scripts would be nice. Also, some documentation on expected output when scripts are run successfully and unsuccessfully.

@aih
Copy link
Collaborator

aih commented Aug 20, 2020

Did you still want to include the info on the scraper? Or perhaps a caveat about it actually taking a long time to run?

I've updated this. It may still need more detail. Feel free to add.

Also noting the $ python3 command with macs. Python novice here, so wasn't immediately apparent the difference between the commands "python" and "python3".

Yes, there's probably a good section to write on Python. We should probably recommend using a Python version manager like pyenv venv and setting the environment to Python 3. We need to check if there are dependencies that are not in plain Python 3, and add those. We also require a minimum Python 3.7, I think because I'm using type hints. Can you research these details and add a section on Python?

I think some language describing in better detail where the congress data should exist in the repo before you run the scripts would be nice.

I've added this. Feel free to expand.

Also, some documentation on expected output when scripts are run successfully and unsuccessfully.
Can you do this, based on your experience and the documentation in the scripts?

@aih
Copy link
Collaborator

aih commented Sep 2, 2020

The initial changes have been added. Closing.

@aih aih closed this as completed Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants