A free website that keeps the people informed about housing and evictions.

Overview

Eviction Tracker

Currently helping verify detainer warrant data for middle Tennessee - via Middle TN DSA - Red Door Collective

Features

  • Presents data visualizations for community awareness
  • Organizer Portal
    • Create direct action campaigns
    • Schedule events for campaigns
    • Record relevant information for phonebanking sessions
  • Admin Portal
    • Create and update detainer warrants

Development

Setup

You'll need to set a few secret environment variables before booting the app.

You can copy-paste the following lines into your terminal if you're using bash.

echo 'export TWILIO_ACCOUNT_SID=fake' >> ~/.bash_profile
echo 'export TWILIO_AUTH_TOKEN=fake' >> ~/.bash_profile

Then, you can either run source ~/.bash_profile or open a new terminal tab and proceed to the next step.

If you're wondering what the above code does: it defines two environment variables with the value "fake" and ensures they are available in all future (bash) shell sessions. TODO: make this process less painful.

Nix

Nix is a tool we use to ensure reproducable builds and deployments. Python's default build and deployment system is notoriously tricky. We've elected to use Nix instead to ease setup. Nix can be used for installing and deploying multiple languages, which may end up being useful for this project.

Install Nix

Please follow the instructions to install Nix on their website.

(Please ignore instructions regarding NixOS - that's a whole new operating system).

Using Nix

To work with the same python version as everyone else working on this project, you'll need to make sure you're in the nix-shell first.

  1. Check that you're in the same directory as shell.nix
  2. Type nix-shell and hit enter
  3. Wait for necessary dependencies to install from the internet to your machine

You'll get a new prompt that looks like:

[nix-shell:~/some/path/eviction-tracker]$ 

Now you're ready to run python and ipython! You can escape the nix-shell at any time by holding ctrl pressing the D key or typing exit and pressing enter.

Database

We use PostgreSQL for both development and production so that we can be assured working with the data locally will work exactly the same in production. Unfortunately, this requires a bit more manual setup for developers who don't already use Postgres.

First-time postgres

Install postgres with the most convenient installer for your OS.

The app doesn't care how you set up your postgres connection, so feel free to set up your postgres service in whatever method is convenient for you. By default, the SQLALCHEMY_DATABASE_URL is set to postgresql+psycopg2://[email protected]/eviction_tracker, which assumes that you've created a database called eviction_tracker, a user called eviction_tracker (without a password), and that you are using the default host and port of a postgres service running on the same host as the app.

Feel free to override this environment variable like SQLALCHEMY_DATABASE_URL="..." flask shell or create the same setup locally. If you're running your database on another host like a Docker container, you'll need to change localhost and possibly add a :port to your override.

Some postgres instructions on setting up for the default flow:

psql -U postgres # or, the superuser you've set up. -U postgres is default for modern installs

The above command will place you in this postgres shell:

postgres=# CREATE DATABASE eviction_tracker;
postgres=# CREATE USER eviction_tracker;
postgres=# GRANT ALL ON eviction_tracker to eviction_tracker;

These commands create the database, user, and assign all privileges for the user to the development database;

Migrations

Make sure to run flask db upgrade after setting up your database, or whenever a new migration is added to the migrations/ folder.

Google Spreadsheets

You'll need authentication to make requests to the online spreadsheet with the most current data.

Please install Keybase, a secure messaging platform. I will send any contributor who requests the authentication secrets the necessary file. When I send the file over Keybase, you'll need to download it, and move it somewhere you won't lose it.

By default, our scripts expect the file to be at the following path: ~/.config/gspread/service_account.json. In plain english: it should be in your home directory, under a hidden folder named .config and finally inside another folder called gspread. The file should be named service_account.json. If these are all true, you're good to go! If you'd like to save the file elsewhere or rename it, just run the script with your custom path under the optional argument: --service_account_key=/path/to/your/file.json.

Using a REPL

REPL (Read Eval Print Loop) is a concept implemented in many programming languages. If you've never written python before, we recommend spending an afternoon on these basics. You'll interact with a REPL in those courses.

While in a Nix Shell, launch the IPython shell like so:

ipython

And now, you can write python code with any of our libraries!

Running commands

While in a Nix Shell, run flask .

Bootstrap

You'll want to set up a small set of users and roles for development.

Run flask bootstrap to provision users and roles.

Afterwards, you'll be able to login to several demo users with varying roles.

  1. Superuser - [email protected]:123456
  2. Admin - [email protected]:123456
  3. Organizer - [email protected]:123456
  4. Defendant - [email protected]:123456

Sync database

To sync the data from our org's Google Spreadsheet, run flask sync .

If you want just a bit of data to work with locally, pass the --limit argument.

Example: flask sync --sheet-name 'detainer-warrants_15-02-2020' --limit 10 will populate the database with 10 detainer warrants from the spreadsheet titled detainer-warrants_15-02-2020.

Run app

To run the website locally, use flask run --no-reload within the nix-shell.

You'll be able to visit it at http://127.0.0.1:5000/

You can browse api endpoints like detainer warrants at http://127.0.0.1:5000/api/v1/detainer-warrants

Comments
  • Save a mock twilio response to the database

    Save a mock twilio response to the database

    Context

    Before we verify any phone numbers, we need to make sure we can save the verification data so we never lose what we've paid for. We are building a database of information: detainer warrants, attorneys, defendants, etc. There will also be a table for phone_number_verifications. We will then always be able to look up our data from Twilio in that database.

    Description

    This should serve as a test that our code will do the right thing when eventually validating a phone number.

    We should make sure that the JSON response documented by Twilio is able to be saved to the database.

    Example JSON response

    {
      "caller_name": {
        "caller_name": "Delicious Cheese Cake",
        "caller_type": "CONSUMER",
        "error_code": null
      },
      "carrier": null,
      "country_code": "US",
      "national_format": "(510) 867-5310",
      "phone_number": "+15108675310",
      "add_ons": null,
      "url": "https://lookups.twilio.com/v1/PhoneNumbers/+15108675310"
    }
    

    Modeling

    We need to build a database table to properly model this data before inserting it.

    I suggest:

    class PhoneNumberVerification(Base):
        __tablename__ = 'phone_number_verifications'
        id = Column(Integer, foreign_key=True)
        caller_name = Column(String)
        caller_type = Column(Integer) # smaller column than String
        error_code = Column(Integer)
        carrier = Column(String)
        country_code = Column(String)
        national_format = Column(String)
        phone_number = Column(String)
    

    This is actively under construction. Follow progress in #6.

    Inserting

    Please follow SQLAlchemy docs for how to insert this kind of data to the database

    Testing

    We don't yet have a test suite, i'll comment on this issue when we do. When that is set up, we can write a test to close out this issue:

    1. Create mock JSON data
    2. Test that the JSON can be inserted into the phone_number_verifications table
    opened by gregziegan 3
  • Test Twilio Phone Verfication Database Insertion

    Test Twilio Phone Verfication Database Insertion

    This creates a test to ensure a mock JSON Twilio response can be saved as a valid PhoneNumberVerification entry. A second test was added that checks the input of the mock Twilio response to what is saved in the database.

    opened by donald-mate 1
  • Set up SQLite database

    Set up SQLite database

    Binary files are bloated and terrible way to manage data over time. Let's use a simple database like SQLite for the time being.

    Checklist

    • [x] Set up SQLite for local development
    • [x] Create tables for detainer warrants and associated data
    • [ ] Create table for phone number verifications
    • [ ] Automate spreadsheet insertion into detainer warrant table
    opened by gregziegan 1
  • Separate Judgments from Hearings

    Separate Judgments from Hearings

    Context

    The site uses the concept of a Judgment to refer to both a hearing (scheduled court date) and its outcome. This is OK, but makes matching Judgment to hearings difficult as the only method of matching judgments to hearings is via court and file date. The judgment document is filed sometime after the court date. We can use this knowledge to guess which judgment corresponds to which hearing. This code was quite messy to work with when there were not two separate tables.

    Description

    Hearings and Judgments

    This PR introduces another table for hearings, where web scraping of the CircuitClerk will always be the sole author of that data. Users will not be able to edit hearing details. Judgment data is now connected to hearings via automatic PDF scraping, with an ability for users to fix details of the scraping.

    UI changes

    The detainer warrant is now merely a landing page for hearings and judgments. You must edit a judgement on a judgment page. There is now a Judgments table UI to help expedite auditing of judgments.

    Database changes

    I tried to get the migration scripts working for the data transition but got stuck on certain SQL transactions. After messing with it for a few hours i decided this was not worth the time since we always have a data backup since mid-November via google sheets and database dumps on the production server. I'll instead be executing sqlalchemy queries through the flask shell to fix data.

    opened by gregziegan 0
  • Convert to Paack-ui; remove extraneous fields; expand Judgement

    Convert to Paack-ui; remove extraneous fields; expand Judgement

    1. convert to paack-ui
    2. remove presiding judge from warrant
    3. move court date and court room to "judgements"
    4. switch to posix for all date and datetime columns
    opened by gregziegan 0
  • An organizer can record info from their phonebank into a form on the website

    An organizer can record info from their phonebank into a form on the website

    Phone Bank Script

    Let's add some text fields to capture notes.

    There's a lot of "If" statements in the script that would be great to automate. Say, click a button and another piece of the form shows up.

    opened by gregziegan 0
Releases(v314)
Programa principal de la Silla C.D.P.

Silla CDP Página Web Contáctenos Lista de contenidos: Información del proyecto. Licencias. Contacto. Información del proyecto Silla CDP, o Silla Corre

Silla Control de Postura 1 Dec 02, 2021
Powerful virtual assistant in python

Virtual assistant in python Powerful virtual assistant in python Set up Step 1: download repo and unzip Step 2: pip install requirements.txt (if py au

Arkal 3 Jan 23, 2022
Python AVL Protocols Server for Codec 8 and Codec 8 Extended Protocols

pycodecs Package provides python AVL Protocols Server for Codec 8 and Codec 8 Extended Protocols This package will parse the AVL Data and log it in hu

Vardharajulu K N 2 Jun 21, 2022
Attempt at creating organized collection of little handy snippets of code I'm receiving along the way

ChaosCode Attempt at creating organized collection of little handy snippets of code I'm receiving along the way I always considered coding and program

INFU 4 Nov 26, 2022
👀 nothing to see here

Woofy Woofy is blue dog companion token of YFI (Wifey) It utilizes a special Woof bonding curve which allows two-way conversion between the tokens. Th

Yearn Finance 36 Mar 14, 2022
Random pass word generator made with python. PyQt5 module is used to design GUI.

Differences in this GUI program : Default titlebar removed Custom Minimize,Maximize and Close Buttons Drag & move window from any point Program work l

Dimuth De Zoysa 1 Jan 26, 2022
Painel de consulta

⚙ FullP 1.1 Instalação 💻 git clone https://github.com/gav1x/FullP.git cd FullP pip3 install -r requirements.txt python3 main.py Um pequeno

gav1x 26 Oct 11, 2022
Python wrapper to different clients to determine how a particular term is used.

Python wrapper to different clients to determine how a particular term is used.

Chris Mungall 3 Oct 24, 2022
⏰ Shutdown Timer is an application that you can shutdown, restart, logoff, and hibernate your computer with a timer.

Shutdown Timer is a an application that you can shutdown, restart, logoff, and hibernate your computer with a timer. After choosing an action from the

Mehmet Güdük 5 Jun 27, 2022
A minimal configuration for a dockerized kafka project.

Docker Kafka Quickstart A minimal configuration for a dockerized kafka project. Usage: Run this command to build kafka and zookeeper containers, and c

Nouamane Tazi 5 Jan 12, 2022
Fetch data from an excel file and create HTML file

excel-to-html Problem Statement! - Fetch data from excel file and create html file Excel.xlsx file contain the information.in multiple rows that is ne

Vivek Kashyap 1 Oct 25, 2021
A script to add issues to a project in Github based on label or status.

Add Github Issues to Project (Beta) A python script to move Github issues to a next-gen (beta) Github Project Getting Started These instructions will

Kate Donaldson 3 Jan 16, 2022
Ramadhan countdown - Simple daily reminder about upcoming Ramadhan

Ramadhan Countdown Bot Simple bot for displaying daily reminder about Islamic pr

Abdurrahman Shofy Adianto 1 Feb 06, 2022
Python Classes Without Boilerplate

attrs is the Python package that will bring back the joy of writing classes by relieving you from the drudgery of implementing object protocols (aka d

The attrs Cabal 4.6k Jan 02, 2023
Python decorator for `TODO`s

Python decorator for `TODO`s. Don't let your TODOs rot in your python projects anymore !

Klemen Sever 74 Sep 13, 2022
Integer sets where all subsets have unique sums

Evil Sums Generation of sets of numbers where all constituents are recoverable from a partial sum.

Charlotte 5 Sep 24, 2022
Handwrite - Type in your Handwriting!

Handwrite - Type in your Handwriting! Ever had those long-winded assignments, that the teacher always wants handwritten?

coded 7 Dec 06, 2022
Return-Parity-MDP - Towards Return Parity in Markov Decision Processes

Towards Return Parity in Markov Decision Processes Code for the AISTATS 2022 pap

Jianfeng Chi 3 Nov 27, 2022
Block fingerprinting for the beacon chain, for client identification & client diversity metrics

blockprint This is a repository for discussion and development of tools for Ethereum block fingerprinting. The primary aim is to measure beacon chain

Sigma Prime 49 Dec 08, 2022
A simple wrapper to analyse and visualise reinforcement learning agents' behaviour in the environment.

Visrl Visrl (pronounced "visceral") is a simple wrapper to analyse and visualise reinforcement learning agents' behaviour in the environment. Reinforc

Jet New 14 Jun 27, 2022