Write My MLA

Helping Canadian Citizens write their MLA, MPP, MNA, or MHA using the power of AI.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Deployment
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Write My MLA is an application that helps Canadian citizens write their local MLA, MPP, MNA, or MHA. The application uses the postal code of the user to search for their representative, and then input the issue that they're experiencing. Their experience is sent to either the OpenAI api, or a local instance of the GPT4all api to generate a professional letter that can then be sent on to their local representative.

(back to top)

Built With

This application was developed in Python and deployed on Streamlit.io with the intention that it can be quickdly and easily re-deployed and re-used on this platform.

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• pip

  python get-pip.py
  pip install --upgrade openai
  pip install streamlit

• openai

  pip install --upgrade openai

• streamlit

  pip install streamlit

Installation

1. Get an API Key for openAI at https://platform.openai.com/account/api-keys

2. Clone the repo

   git clone https://github.com/brysonbest/writemymla.git

3. Create .streamlit/.secrets.toml folder and file in the root directory and add your API key

   mkdir .streamlit
   cd .streamlit
   touch .secrets.toml

   openai_key="your key here"

4. Local Deployment

   streamlit run writemymla.py

Deployment

1. Create a streamlit.io account https://share.streamlit.io/signup
2. Deploy your application following the instructions at https://docs.streamlit.io/en/stable/deploy_streamlit_app.html

(back to top)

Usage

Use this application to search for and write Canadian MLA's, MPP's, MNA's, or MHA's. The application will return the name, party, and contact information for the representative, and provide the user with the opportunity to create an AI-generated letter. This is a not-for-profit project intended to aid citizens with finding their representatives.

Disclaimer

The application is not intended to be used for any other purpose. Information is not vetted prior to dissemination, and may be inaccurate. Please go to your provincial website for the most up-to-date information. The application is not affiliated with any government body. Any actions taken based on the information provided by this application are the sole responsibility of the user.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/brysonbest/writemymla

(back to top)

Acknowledgments

• Geocoder.ca Provided the API used to accurately search using postal code information.
• Represent Civic Information API Provided the API used to search for representatives based on location.
• OpenAI API Provided the API used to generate letters based on user input details.
• GPT4All API provided an open-source alternative for letter generation based on the user details.

OpenAI Provides the letter generation based on the user details

(back to top)