Code Monkey home page Code Monkey logo

congress-api's Introduction

Congress Build Status

This is the API address for propublica: [propublica link] (https://projects.propublica.org/api-docs/congress-api/) This repo is a python package to access the propublica API.

To get started clone the repo locally and

  1. Ask Zach to get permissions to push branches
  2. Choose an issue to work on and comment that you want to work on it. Or create your own issue and comment that you want to work on that.
  3. Make a branch (or two or three or ...) and open up a PR with a change you like. Some issues will already have PRs open, just push to those branches!
  4. Ask for a review from a peer.
  5. Ask for a review from Zach, Tim or Dylan.
  6. Once both reviews are passed, an instructor will merge.

Some useful commands:

  • Checkout new branch git checkout -b branch_name
  • Push new branch git push --set-upstream origin branch_name
  • Switch branches git checkout branch_name
  • Rebase on master git rebase master

This is a Python 3 application

Helpful Hints

Run tests with python -m pytest

Message for Zach

Hey Zach, I'm demonstrating pull requests. Have a look at this! Here's some additional clarifying lines.

congress-api's People

Contributors

dafeii17 avatar dzbee avatar johnmarcampbell avatar zachglassman avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

congress-api's Issues

Validators

We have a base validator but it doesn't currently do anything. It would be useful to implement it, although this is likely a substantial task.

Documentation

Docstrings for the various classes and functions. README for installation.

better README

This README doesn't really go over what this repo actually does, lets fix that!

Other endpoints

We've implemented some methods that call the members endpoint of the API, but https://projects.propublica.org/api-docs/congress-api/ shows a variety of others (bills, votes, etc.). We need to provide access to the full API.

  • Bills endpoint
  • Votes endpoint
  • Statements endpoint
  • Committees endpoint
  • Nominations endpoint
  • Floor actions endpoint
  • Lobbying endpoint

pylint

pylint is a useful tool for linting Python code. It can find a bunch of common mistakes as well as enforce some sort of style. We should use it (or a similiar tool) in a our tests.

Testing

Implement testing for Congress class

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.