Skip to content

README.md

Latest commit

 

History

History
82 lines (61 loc) · 1.78 KB

README.md

File metadata and controls

82 lines (61 loc) · 1.78 KB

earnings-calendar-to-google-calendar

A Django application that fetches Earnings events from an API and syncs them with Google Calendar.

Temporary Working Notes

  1. MOVE THESE NOTES TO A BETTER, DEDICATED TRACKER.
  2. Need to add Contact Form
  3. Need to fix off-by-one date error
  4. Need to fix Download .ics UI
  5. Need to rearrange columns
  6. Need to add disclaimers and issues with final date variability

Features

  • Fetch Earnings events from API
  • Google Calendar integration
  • Customizable event selection
  • Automated calendar syncing

Requirements

  • Python 3.10
  • Django 4.2.7
  • Other dependencies listed in requirements.txt

Setup

  1. Clone the repository:
git clone https://github.com/yourusername/earnings-calendar-to-google-calendar.git
cd earnings-calendar-to-google-calendar
  1. Create and activate a virtual environment:
python -m venv yourenvname
source yourenvname/bin/activate  # On Windows use: yourenvname\Scripts\activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Create a .env file with the following variables:
DJANGO_SECRET_KEY=your-secret-key
DJANGO_DEBUG=True
ALPHA_VANTAGE_API_KEY=your-alpha-vantage-api-key
GOOGLE_OAUTH_CLIENT_ID=your-google-oauth-client-id
GOOGLE_OAUTH_CLIENT_SECRET=your-google-oauth-client-secret
  1. Run migrations:
python manage.py migrate
  1. Create a superuser:
python manage.py createsuperuser
  1. Run the development server:
python manage.py runserver

Usage

  1. Visit Site
  2. Fetch the earnings events you want to track
  3. Sync events to your Google Calendar

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT
⚡